Справочник API

Коды ошибок

Полный справочник по каждому коду ошибки, который может вернуть API TokSpan, с описаниями и шагами по устранению.

Коды состояния HTTP

КодЗначениеДействие
400Неверный запросПроверьте тело запроса на наличие некорректного JSON или отсутствующих обязательных полей
401Не авторизованПроверьте, что ваш API-ключ действителен и активен в панели управления
404Неверный URL / конечная точка не найденаПроверьте путь запроса по справочнику API
429Превышен лимит запросов / недостаточно квотыДля лимитов запросов реализуйте экспоненциальную задержку с джиттером. Если ошибка упоминает квоту или баланс (например, insufficient_user_quota), пополните баланс в панели управления вместо повторов — см. лимиты запросов
500Внутренняя ошибкаПроблема на стороне TokSpan — повторите запрос с задержкой или обратитесь в поддержку
502Ошибка шлюзаОшибка upstream-провайдера — может активироваться автоматическое переключение
503Сервис недоступен / модель не найденаВременная перегрузка — повторите с задержкой. Если ошибка содержит код model_not_found, модель недоступна для вашего ключа — проверьте название модели в каталоге моделей

Формат ответа с ошибкой

Ошибки возвращаются в объекте error с читаемым message и идентификатором type. В TokSpan type обычно равен new_api_error, а ошибки баланса аккаунта сопровождаются code: "insufficient_user_quota". Пример:

json
{
  "error": {
    "message": "You can access all models, but this request exceeded your account balance. Please top up at the Dashboard.",
    "type": "new_api_error",
    "param": null,
    "code": "insufficient_user_quota"
  }
}

Важно читать сообщение. 429 с сообщением о лимите запросов означает «подожди и повтори», а 429 (или 400) с сообщением о квоте — «сначала пополни баланс». Прежде чем решать, как реагировать, прочитайте сообщение. Приведённый текст сообщения является иллюстративным — всегда опирайтесь на код состояния HTTP и поле code.