OpenAI API
Базовый адрес OpenAI API — https://hub.coreinfra.ai/openai/api/v1. Ниже перечислены HTTP-методы и WebSocket-соединения этого API; поля запросов описаны в документации OpenAI.
API методы
Пути в таблице указаны относительно базового адреса.
| Метод | Путь | Назначение |
|---|---|---|
GET, OPTIONS | /models | Каталог моделей |
POST, OPTIONS | /chat/completions | OpenAI Chat Completions |
POST, OPTIONS | /responses | OpenAI Responses |
GET, WebSocket Upgrade | /responses | Responses по WebSocket |
POST, OPTIONS | /responses/input_tokens | Подсчет входных токенов |
POST, OPTIONS | /decisions | OpenAI Decisions |
POST, OPTIONS | /images/generations | Генерация изображений |
POST, OPTIONS | /images/edits | Редактирование изображений |
POST, OPTIONS | /embeddings | Векторы |
POST, OPTIONS | /audio/speech | Синтез речи |
GET, WebSocket Upgrade | /realtime | Realtime |
CORS OPTIONS поддерживается для путей, отмеченных в таблицах.
Для подписки ChatGPT базовый адрес — https://hub.coreinfra.ai/openai/subscription/api/v1. Пути ниже указаны относительно него.
| Метод | Путь | Назначение |
|---|---|---|
GET, OPTIONS | /models | Каталог моделей подписки |
POST, OPTIONS | /responses | Ответ модели |
GET, WebSocket Upgrade | /responses | Responses по WebSocket |
POST, OPTIONS | /responses/compact | Сжатие контекста |
POST, OPTIONS | /alpha/search | Поиск |
POST, OPTIONS | /images/generations | Генерация изображений |
POST, OPTIONS | /images/edits | Редактирование изображений |
Доступ и модели
Запросы к моделям по основному базовому адресу принимают Authorization: Bearer sk-ci2-.... Заголовки OpenAI-Organization и OpenAI-Project игнорируются. Каталог моделей доступен без ключа и включает несколько видов моделей: наличие идентификатора в каталоге само по себе не означает, что модель подходит любому API методу. Совместимость моделей с API методами приведена в каталоге моделей, цены — на «Тарифах».
Для адресов подписки ключ хаба передается в X-CoreInfra-API-Key, токен подписки — в Authorization: Bearer ….
Ответы и потоки
OpenAI Chat Completions и OpenAI Responses поддерживают stream: true: ответ передается как SSE с Content-Type: text/event-stream. Chat Completions передает JSON в строках data: и завершает успешный поток маркером data: [DONE]; Responses использует именованные события event: .... При конвертации хаб формирует события того протокола, который вызвал клиент.
Images также поддерживает потоковый режим SSE для моделей GPT Image. Синтез речи возвращает аудиобайты либо SSE по stream_format. Decisions, Embeddings и подсчет токенов возвращают только JSON. Соединения WebSocket обмениваются JSON-событиями после ответа со статус-кодом 101.
Ошибки
Ошибки имеют формат OpenAI:
{
"error": {
"message": "Missing required parameter: 'model'.",
"type": "invalid_request_error",
"param": null,
"code": null
}
}
Для ошибок сервера используется type: "server_error", для ограничения частоты — "rate_limit_error", для доступа — "permission_error". Некоторые проверки задают собственные param и code; они перечислены на страницах соответствующих API методов.
Общие ошибки авторизации, баланса и лимитов расходов описаны в общем справочнике.
Если ошибка возникает после начала потокового ответа SSE, она передается событием потока. Например, в OpenAI Responses (наряду с терминальным событием response.failed):
event: error
data: {"type":"error","code":"server_error","message":"The server had an error while processing your request.","param":null,"sequence_number":2}
В потоке OpenAI Chat Completions кадр ошибки имеет вид:
data: {"error":{"type":"server_error","message":"Stream error"}}
