Справочник API
Обзор API
Общие правила публичного API /v1
Публичный API Gateway включает OpenAI-совместимые маршруты для моделей и Tools API для поиска, извлечения страниц и исследовательских задач.
Base URL: {{PUBLIC_API_BASE_URL}}
Authorization: Bearer gw_live_...Общие правила
- Все запросы к моделям требуют ключ API.
- Все запросы к Tools API также требуют ключ API.
- Ключ передаётся в заголовке
Authorization. - JSON-запросы используют
Content-Type: application/json. - Имена моделей берите из
GET /v1/modelsили из Дашборда. - Не передавайте служебные заголовки, ручную маршрутизацию и внутренние параметры поставщиков.
Группы маршрутов
| Группа | Для чего нужна |
|---|---|
| Models API | Список доступных моделей. |
| Chat, Messages, Responses, Completions | Генерация текста и диалоговые сценарии. |
| Embeddings, OCR, Rerank | Подготовка данных, поиск по смыслу и сортировка результатов. |
| Images и Audio | Генерация изображений, речь и транскрибация. |
| Async Routes | Долгие задачи с job_id. |
| Tools API | Поиск, извлечение страниц, обход сайтов и исследование внешних источников. |
Пример
curl {{PUBLIC_API_BASE_URL}}/chat/completions \
-H "Authorization: Bearer gw_live_..." \
-H "Content-Type: application/json" \
-d '{
"model": "provider/model-name",
"messages": [
{"role": "user", "content": "Ответь коротко."}
]
}'Tools API вызывается тем же ключом:
curl "{{PUBLIC_API_BASE_URL}}/tools/serpapi/search?q=ai%20search&engine=google" \
-H "Authorization: Bearer gw_live_..."Ошибки
| Код | Что значит |
|---|---|
400 | Неверный формат запроса. |
401 | Ключ не передан, неверный или отозван. |
403 | Нет доступа, подписки, разрешения на модель или инструмент либо ключ выключен. |
404 | Объект не найден. |
429 | Превышен лимит скорости или токенов. |
5xx | Временная ошибка платформы или модели. |
Повторять стоит только временные ошибки: 429, 502, 503, 504.