Обзор API
OfoxAI предоставляет три протокола доступа к API, полностью совместимых с официальными SDK каждого провайдера.
Base URL
| Протокол | Base URL | Описание |
|---|---|---|
| Совместимость с OpenAI | https://api.ofox.ai/v1 | Совместим с OpenAI SDK, поддержка всех моделей |
| Нативный Anthropic | https://api.ofox.ai/anthropic | Совместим с Anthropic SDK, нативная работа с Claude |
| Нативный Gemini | https://api.ofox.ai/gemini | Совместим с Google GenAI SDK |
Аутентификация
Все протоколы используют единый OfoxAI API Key, но формат заголовка зависит от протокола:
| Протокол | Заголовок | Формат |
|---|---|---|
| OpenAI | Authorization | Bearer sk-xxx |
| Anthropic | x-api-key | sk-xxx |
| Gemini | x-goog-api-key | sk-xxx |
Подробности см. в разделе Аутентификация.
Доступные эндпоинты
Протокол совместимости с OpenAI
| Эндпоинт | Метод | Описание |
|---|---|---|
/v1/chat/completions | POST | Создание ответа чата |
/v1/embeddings | POST | Создание текстовых эмбеддингов |
/v1/models | GET | Список доступных моделей |
/v1/models/{model_id} | GET | Получение информации о модели |
/v1/images/generations | POST | Генерация изображений |
Нативный протокол Anthropic
| Эндпоинт | Метод | Описание |
|---|---|---|
/anthropic/v1/messages | POST | Создание сообщений |
Нативный протокол Gemini
| Эндпоинт | Метод | Описание |
|---|---|---|
/gemini/v1beta/models/{model}:generateContent | POST | Генерация контента |
/gemini/v1beta/models/{model}:streamGenerateContent | POST | Потоковая генерация контента |
Лимиты запросов
OfoxAI работает по модели оплаты за использование. Все пользователи имеют единую политику ограничений:
| Параметр | Лимит |
|---|---|
| RPM (запросов/мин) | 200 |
| TPM (токенов/мин) | Без ограничений |
Если вам нужен более высокий лимит, обратитесь в поддержку OfoxAI для его увеличения.
При превышении лимита API возвращает 429 Too Many Requests с заголовками:
x-ratelimit-limit-requests: 200
x-ratelimit-remaining-requests: 0
x-ratelimit-reset-requests: 1sКоды ошибок
Все протоколы возвращают унифицированные HTTP-коды состояния:
| Код | Описание | Типичная причина |
|---|---|---|
200 | Успех | — |
400 | Некорректный запрос | Ошибка формата параметров, отсутствие обязательных полей |
401 | Ошибка аутентификации | Недействительный или истёкший API Key |
403 | Недостаточно прав | Нет доступа к данной модели |
404 | Ресурс не найден | Ошибка в ID модели |
429 | Превышен лимит | Превышен лимит запросов |
500 | Ошибка сервера | Внутренняя ошибка, повторите попытку |
502 | Ошибка upstream | Сбой сервиса провайдера модели |
503 | Сервис недоступен | Техническое обслуживание |
Формат ответа об ошибке
{
"error": {
"code": "invalid_api_key",
"message": "Предоставленный API Key недействителен. Проверьте и повторите попытку.",
"type": "authentication_error"
}
}Расширенные параметры OfoxAI
OfoxAI предоставляет расширенные параметры поверх стандартных протоколов для управления маршрутизацией и аварийным переключением:
{
"model": "openai/gpt-4o",
"messages": [...],
"provider": {
"routing": "cost",
"fallback": ["anthropic/claude-sonnet-4.5", "google/gemini-3-flash-preview"]
}
}Подробности см. в разделах Маршрутизация провайдеров и Аварийное переключение.