CyHUBДокументация API v1
Документация API

Ошибки и лимиты

Что делать, если запрос не выполнился.

Формат ошибки

Любой ответ с ошибкой устроен одинаково: code для программы, message для человека на языке запроса (Accept-Language или ?lang).

JSON
{
  "error": {
    "code": "insufficient_funds",
    "message": "Не хватает средств: нужно ещё 2500 в минорных единицах. Пополните баланс в кабинете."
  }
}

Коды ответов

HTTPКодЧто делать
401invalid_api_keyПроверьте ключ. Отозванный или отсутствующий ключ замените новым из кабинета.
402insufficient_fundsПополните баланс, задача не создана.
403model_not_allowed_for_keyКлючу не разрешена эта модель: набор моделей ключа меняется в кабинете, раздел «Ключи доступа».
403key_daily_limit_exceededЛимит трат ключа на сутки исчерпан, задача не создана. Сутки по Москве; лимит меняется в кабинете.
404model_not_found, task_not_foundПроверьте ключ модели (GET /v1/models) или id задачи.
404artifact_expiredСрок хранения файлов результата вышел.
404not_foundТакого адреса нет. В ответе поля docs, openapi и llms со ссылками на описание API.
405method_not_allowedАдрес не принимает этот метод запроса: разрешённые в заголовке Allow, ссылки на описание API в ответе.
409idempotency_conflictПод этой меткой уже есть задача с другими настройками, возьмите новую метку.
409request_in_progressЗадача под этой меткой ещё создаётся: повторите тот же запрос через несколько секунд.
413request_too_large, file_too_largeУменьшите тело запроса или файл.
422invalid_settings, unknown_settingСверьте settings со страницей модели: подробности в message.
422invalid_request, file_type, file_emptyПроверьте форму запроса, формат и содержимое файла.
429rate_limited, too_many_activeПодождите: превышен лимит запросов или одновременных задач модели.
503model_unavailable, sg_unavailableМодель на обслуживании или сервер генераций недоступен, повторите позже.
500internal_errorОшибка на нашей стороне, повторите позже; если повторяется, напишите в поддержку.

Лимиты

  • 120 запросов в минуту на кабинет; ключи одного кабинета делят лимит.
  • 30 запросов с неверным ключом в минуту с одного адреса.
  • Тело JSON у задач и цены до 64 КБ, у остальных запросов до 16 КБ.
  • Одновременных задач одной модели столько же, сколько у бота: при превышении 429 too_many_active.
  • До 10 активных ключей в кабинете.
  • Ключу можно оставить только нужные модели и лимит трат в сутки (по умолчанию все модели и без лимита). Свои права ключ видит в GET /v1/me, а GET /v1/models с таким ключом показывает только его модели.

Модель может быть временно выключена: available в GET /v1/models показывает это заранее, постановка задачи отвечает 503 model_unavailable.