APIWAY / Документация API
От ключа до первого ответа.
Адрес, ключ и модель, примеры curl и Python, потоковый режим, учёт расхода и коды ошибок. Доступность и тариф проверяйте в живом каталоге сервиса.
На этой странице: состав запроса · первый запрос · стриминг · расход · ошибки · лимиты · словарик · клиенты
Что такое API-запрос.
API — способ, которым ваша программа общается с нейросетью: вы отправляете текст запроса, сервис передаёт его модели и возвращает ответ. Каждый запрос — обычный HTTPS-вызов с вашим ключом, как у любого сайта, только ответ приходит не страницей, а данными в формате JSON.
Три параметра запроса.
- Адрес
https://api.apiway.ru/v1— один базовый адрес для всех запросов. Основной путь —/chat/completions, формат Chat Completions.- Ключ
- Создаётся в личном кабинете, раздел «Ключи». Передаётся в заголовке
Authorization: Bearer. Храните ключ как пароль. - Модель
- Укажите точный Model ID подключённой модели, например
gpt-5.6-luna. Перед запросом проверьте тариф, разрешения ключа и баланс. Актуальный список — в каталоге: он загружается прямо из сервиса.
ПЕРВЫЙ ЗАПРОС
Скопируйте и выполните.
Ключ читается из переменной окружения APIWAY_KEY — так он не попадёт в код, скриншоты и историю команд.
curl
export APIWAY_KEY="ваш_ключ"
curl --fail-with-body --max-time 60 https://api.apiway.ru/v1/chat/completions \
-H "Authorization: Bearer $APIWAY_KEY" \
-H "Content-Type: application/json" \
--data "{\"model\":\"gpt-5.6-luna\",\"messages\":[{\"role\":\"user\",\"content\":\"Объясни, что такое API, в двух предложениях\"}]}"Python · стандартная библиотека
import json
import os
from urllib.request import Request, urlopen
payload = {"model": "gpt-5.6-luna", "messages": [
{"role": "user", "content": "Объясни, что такое API, в двух предложениях"}]}
request = Request("https://api.apiway.ru/v1/chat/completions",
data=json.dumps(payload).encode(),
headers={"Authorization": "Bearer " + os.environ["APIWAY_KEY"],
"Content-Type": "application/json"})
with urlopen(request, timeout=60) as response:
result = json.load(response)
print(result["choices"][0]["message"]["content"])Ответ приходит в JSON: текст модели — в choices[0].message.content. Число токенов по каждому запросу видно в кабинете, вместе с историей.
Первые запросы делайте короткими: так проще увидеть формат ответа и убедиться, что всё настроено.
АНАТОМИЯ ЗАПРОСА
Из чего состоит запрос.
Каждый запрос — один POST-вызов. В нём три составляющие: адрес, два заголовка и тело в формате JSON. Никаких дополнительных шагов: собрал — отправил — получил ответ.
- Адрес
- Единственный адрес для текстовых запросов, метод POST:
POST https://api.apiway.ru/v1/chat/completions- Заголовок ключа
Authorization: Bearer+ ваш ключ из кабинета — по нему сервис понимает, чей это запрос.- Заголовок формата
Content-Type: application/json— обязателен. Без него сервис не станет разбирать тело и вернёт код 415.- Тело
- JSON с полями запроса: обязательные
modelиmessages, остальное — по желанию.
Тело запроса целиком
{
"model": "gpt-5.6-luna",
"messages": [
{"role": "system", "content": "Ты краткий помощник"},
{"role": "user", "content": "Составь план письма о переносе доставки"}
],
"max_tokens": 300,
"temperature": 0.7,
"stream": false
}- model · обязательно
- ID модели из каталога. Для первого запроса это
gpt-5.6-luna; сверяйте ID с каталогом до символа. - messages · обязательно
- История диалога. Роли:
system— инструкция «как себя вести»,user— ваш запрос,assistant— прошлые ответы модели. Для первого запроса достаточно одного сообщения user. - max_tokens · необязательно
- Предел длины ответа в токенах. Самый простой способ сделать расход предсказуемым.
- temperature · необязательно
- «Творческая шкала»: маленькие значения — ответ строже следует инструкции, большие — свободнее и разнообразнее. Для деловых задач берите небольшое значение.
- stream · необязательно
trueвключает потоковый режим — ответ приходит частями, см. раздел «Стриминг».
Необязательные поля можно не передавать вовсе: запрос из раздела «Первый запрос» работает без них.
СТРИМИНГ
Ответ приходит частями.
Добавьте в запрос "stream": true — и ответ начнёт приходить частями, пока модель ещё отвечает: сервис отдаёт их событиями SSE, по строке data: ... на каждую часть. Сам запрос не меняется: в curl добавьте флаг -N, а в коде читайте ответ построчно, как поток.
curl -N --max-time 120 https://api.apiway.ru/v1/chat/completions \
-H "Authorization: Bearer $APIWAY_KEY" \
-H "Content-Type: application/json" \
--data "{\"model\":\"gpt-5.6-luna\",\"stream\":true,\"messages\":[{\"role\":\"user\",\"content\":\"Напиши короткое поздравление с днём рождения\"}]}"Каждая часть — строка data: с JSON внутри; текст ответа собирают из choices[0].delta.content. Поток закрывается строкой data: [DONE] — это сигнал, что ответ закончен.
Python · стандартная библиотека
import json, os
from urllib.request import Request, urlopen
payload = {"model": "gpt-5.6-luna", "stream": True, "messages": [
{"role": "user", "content": "Напиши короткое поздравление с днём рождения"}]}
request = Request("https://api.apiway.ru/v1/chat/completions",
data=json.dumps(payload).encode(),
headers={"Authorization": "Bearer " + os.environ["APIWAY_KEY"],
"Content-Type": "application/json"})
with urlopen(request, timeout=120) as response:
for line in response:
event = line.decode().strip()
if event.startswith("data: ") and event != "data: [DONE]":
part = json.loads(event[6:])
print(part["choices"][0]["delta"].get("content") or "", end="")
print()Соединение закрывается, когда ответ завершён. Если оно оборвалось раньше — повторите запрос. Расход в потоковом режиме считается так же, как в обычном.
РАСХОД
Как увидеть расход запроса.
В обычном ответе (без stream) есть блок usage: сколько токенов ушло на вход, сколько модель сгенерировала на выходе и сумма. Пересчитывать ничего не нужно — сервис считает за вас.
{
"choices": [{"message": {"role": "assistant", "content": "…"}}],
"usage": {"prompt_tokens": 24, "completion_tokens": 158, "total_tokens": 182}
}Числа в примере условные; сам ответ сокращён до полей, нужных для подсчёта.
Последние 30 записей с токенами и стоимостью доступны в истории кабинета. Сводка по дням пока не предусмотрена. Сверьте usage из ответа с записью в истории: числа должны совпадать — это простой способ убедиться, что учёт работает.
Два правила предсказуемого расхода: ограничивайте длину ответа полем max_tokens и помните, что вся история диалога в messages входит во входные токены — длинный разговор дороже короткого.
КОДЫ ОШИБОК
Если запрос не прошёл.
Каждый сбой сервис помечает HTTP-кодом, а тело ошибки — нейтральный JSON с полем request id. Сохраните request_id вместе со временем и HTTP-кодом. Поиск по request_id в кабинете пока не предусмотрен. Пример ответа сервиса на запрос без ключа:
{"error":{"type":"authentication_required","code":"authentication_required","message":"A valid API key is required.","request_id":"8f14e45fceea167a5a36dedd4bea2543"}}Тело ошибки нейтральное и секретов не содержит; request id у каждого запроса свой.
Разбор любой ошибки — один и тот же: прочитайте код, найдите его в списке ниже, выполните действие и повторите запрос.
- 401 · ключ не принят
- Проверьте, что ключ вставлен целиком, без пробелов, и передан в заголовке
Authorization: Bearer. Если ключ выключен или потерян — создайте новый в кабинете. - 404 · не тот путь или модель
- Сверьте адрес запроса и ID модели с каталогом: ID должен совпадать до символа, путь — заканчиваться на
/v1/chat/completions. - 415 · не тот формат тела
- Добавьте заголовок
Content-Type: application/json— без него сервис не разбирает тело запроса. - 422 · тело не разобрано
- Обычно сломан JSON: проверьте запятые и кавычки, убедитесь, что на месте обязательные
modelиmessages. Надёжный путь — взять пример из раздела «Первый запрос» и добавлять поля по одному. - 429 · лимит исчерпан
- Подождите и повторите. Если в ответе есть заголовок
Retry-After, выждите указанное в нём время. Автоповторы включайте только после того, как разобрались с лимитами. - 402 · вопрос оплаты
- Код связан с условиями тарифа. Для платного запроса нужен достаточный баланс. Пополнение на витрине не подключено; состояние аккаунта и ключа смотрите в кабинете.
- 409 · конфликт
- Запрос не соответствует текущему состоянию. Исправьте параметр, на который указывает сообщение, и повторите.
- 500 / 502 / 503 · проблема на нашей стороне
- Сервис временно недоступен модели временно недоступен. Повторите позже; если ошибка повторяется, снизьте частоту запросов.
РАСХОДЫ И ЛИМИТЫ
Тарифы и ограничения доступа
Запросы к подключённым моделям расходуют баланс по действующему тарифу сервиса. Подтверждённые рублёвые ставки пока уточняются; примеры коэффициентов в рублёвом калькуляторе не заменяют фактические списания. Кабинет показывает статус и срок ключей, баланс и последние 30 записей. Остаток квот поставщиков не отображается. Отдельных публичных запросов для баланса и истории у API нет.
Что подключено прямо сейчас, показывает каталог на сайте — он загружается прямо из сервиса: карточки каталога помечены «В каталоге сервиса».
СЛОВАРИК
Шесть слов, которые нужны для старта.
- Модель
- Конкретная нейросеть, которая отвечает на запросы. У каждой есть ID — он указывается в поле
model. - Каталог
- Список маршрутов из конфигурации сервиса. Наличие записи не гарантирует ответ. Обновляется автоматически — смотрите страницу «Модели».
- Ключ
- Секретная строка, по которой API узнаёт вас. Создаётся в кабинете; храните как пароль.
- Токен
- Единица текста, на которую модель разбирает запрос и ответ — примерно часть слова. В токенах меряют объём и расход.
- Кабинет
- Личный раздел: API-ключи, баланс и последние запросы с токенами и стоимостью.
- Доступ к модели
- Перед первым запросом проверьте наличие модели в каталоге, действующий тариф, баланс и разрешения своего ключа.
КЛИЕНТЫ
Настройки для клиентов
Проверьте поддержку Chat Completions и своего адреса API. Агентным клиентам могут потребоваться другие протоколы.
- Шаблоны первого запроса для curl и Python — на странице подключения.
- Карточки по инструментам — редактор кода, автоматизация, Telegram-бот, тексты и SEO — раздел «Подключите свой инструмент».
- Готовые рецепты под свою задачу — от разбора ошибки до ответов бота — на главной.
Дальше — подключите свой инструмент.
Готовые рецепты для редактора кода, автоматизации и Telegram-ботов собраны на странице подключения. Короткие ответы о ключах, расходах и лимитах — в FAQ.
Перейти к подключению ↗