Обзор API

OfoxAI предоставляет три протокола доступа к API, полностью совместимых с официальными SDK каждого провайдера.

Рекомендация по протоколу: для протокола OpenAI рекомендуем Responses API — у него лучше нативная поддержка Prompt Caching; для моделей Claude рекомендуем нативный протокол Anthropic — он даёт полный набор возможностей и нативное кэширование.

Base URL

Протокол	Base URL	Описание
Совместимость с OpenAI	`https://api.ofox.io/v1`	Совместим с OpenAI SDK, поддержка всех моделей
Нативный Anthropic	`https://api.ofox.io/anthropic`	Совместим с Anthropic SDK, нативная работа с Claude
Нативный Gemini	`https://api.ofox.io/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`

Подробности см. в разделе Получение и использование API Key.

Доступные эндпоинты

Протокол совместимости с 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	Потоковая генерация контента

Типизированные решения (Decisions)

Решения по содержимому в форме «да/нет», выбора одного варианта или оценки по шкале со структурированными ответами и вероятностями. См. документацию Decisions API.

Эндпоинт	Метод	Описание
`/v1/decisions`	POST	Единый формат, также вызывается через OpenAI SDK
`/openai/v1/decisions`	POST	То же, для OpenAI SDK с base URL `/openai/v1`
`/typesafe/v1/systemone`	POST	Официальный формат TypeSafe, совместим с TypeSafe SDK

Генерация видео (совместимо с OpenRouter)

Единый асинхронный API генерации видео. См. документацию Video API.

Эндпоинт	Метод	Описание
`/v1/videos`	POST	Создание задачи генерации видео
`/v1/videos/{id}`	GET	Получение статуса и результата задачи
`/v1/videos/{id}`	DELETE	Отмена задачи

OfoxAI OpenAPI (Аккаунт)

Эндпоинты платформы, не зависящие от протокола, аутентифицируются через OfoxAI API Key.

Эндпоинт	Метод	Описание
`/v1/user/balance`	GET	Запрос баланса, совместим с cc-switch

Лимиты запросов

OfoxAI работает по модели оплаты за использование. Все пользователи имеют единую политику ограничений:

Параметр	Лимит
RPM (запросов/мин)	100 (на уровне команды)
TPM (токенов/мин)	Без ограничений

RPM рассчитывается на уровне команды — несколько API Key одной команды разделяют общую квоту. Если вам нужна более высокая квота RPM, свяжитесь с hi@ofox.ai для её корректировки.

При превышении лимита API возвращает 429 Too Many Requests с заголовками:


x-ratelimit-limit-requests: 100
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-6.1-sol",
  "messages": [...],
  "extra_body": {
    "provider": {
      "fallback": ["anthropic/claude-sonnet-5.5", "google/gemini-3.8-flash"]
    }
  }
}

Параметр provider необходимо размещать в поле extra_body тела запроса: на верхнем уровне он вызывает ошибку 400. Подробности см. в разделах Маршрутизация провайдеров и Аварийное переключение.