Обзор справочника API
Base URL, Bearer auth, основные эндпоинты, OpenAI-совместимый формат запроса и базовые правила ответов GonkaGate API.
Используйте GonkaGate API через https://api.gonkagate.com/v1 с Authorization: Bearer gp-..., отправляйте запросы в POST /v1/chat/completions и обновляйте ID модели через GET /v1/models.
Запросы используют OpenAI-совместимый chat-формат и возвращают либо JSON, либо SSE. Нужен первый рабочий запрос? Начните с Быстрого старта.
Базовые правила API
- Base URL:
https://api.gonkagate.com/v1 - Auth:
Authorization: Bearer gp-... - Основной эндпоинт генерации:
POST /v1/chat/completions - Эндпоинт списка моделей:
GET /v1/models - Непотоковые ответы: JSON с
choicesиusage - Потоковые ответы: добавьте
stream: trueи разбирайте Server-Sent Events (SSE)
Каркас запроса
Используйте эту форму для любого базового вызова POST /v1/chat/completions. Подставьте свежий model из GET /v1/models.
export GONKAGATE_API_KEY="gp-your-api-key"
curl https://api.gonkagate.com/v1/chat/completions \
-H "Authorization: Bearer $GONKAGATE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "<model-id-from-get-v1-models>",
"messages": [
{
"role": "user",
"content": "Reply with the word pong."
}
]
}'Минимальный запрос состоит из base URL, Bearer auth, актуального ID модели и OpenAI-совместимого массива messages.
Правила запроса
- Отправляйте JSON в
POST /v1/chat/completions. - Добавляйте
Authorization: Bearer gp-...иContent-Type: application/json. - Указывайте
modelкак свежий ID модели изGET /v1/models. - Передавайте
messagesв OpenAI-совместимом chat-формате. - Добавляйте
stream: trueтолько если клиент уже умеет разбирать SSE.
Базовое поведение ответов и ошибок
- Непотоковые ответы приходят как JSON. Читайте текст модели из
choices[0].message.content. - Потоковые ответы приходят как SSE
data:-события и завершаются[DONE]. - Классифицируйте сбои по
HTTP status + error.code, а не только по status. - Сохраняйте
x-request-id, если запрос завершился ошибкой или повёл себя неожиданно.
Частые ошибки
- Использовать устаревший ID модели вместо свежего значения из
GET /v1/models. - Одновременно отлаживать auth, выбор модели и форму тела запроса. Проверяйте их в этом порядке.
- Считать любой
429поводом для retry.insufficient_quota— это состояние биллинга, а не ситуация для backoff. - Считать этот обзор полным источником схемы. Точные поля запроса и ответа находятся на справочных страницах эндпоинтов.
См. также
- Создать chat completion для полной схемы
POST /v1/chat/completions, JSON- и SSE-ответов, структуры ошибок иx-idempotency-key. - GET /v1/models для текущих машинно-читаемых ID моделей.
- Потоковые ответы для
stream: true, парсинга SSE и корректного завершения потока. - Обработка ошибок API для правил повторов, остановки и эскалации.
- Аутентификация и API-ключи, если Bearer header или состояние ключа всё ещё под вопросом.
Была ли эта страница полезной?