Ошибки API

Большинство ошибок возвращается JSON-объектом с полем error. Для converter-ошибок также может быть поле message.

Формат

{
  "error": "invalid_api_key"
}

Таблица ошибок

HTTPКодГде возникаетЧто делать
400invalid_jsonJSON endpointsПроверить тело запроса и заголовок Content-Type.
400invalid_emailAuthПередать корректный email.
400email_domain_not_allowedAuthИспользовать email с разрешённым доменом.
400invalid_key_idKeys, UsageПередать корректный Mongo ObjectId ключа.
400invalid_plan_codeBillingИспользовать один из plan codes из документации оплаты.
401auth_requiredCabinet APIВойти в кабинет и передать cookie sid.
401invalid_codeAuthЗапросить новый email-код.
401invalid_api_keyOptimize APIПроверить Bearer API-ключ и статус ключа.
402paid_quota_exhaustedOptimize APIКупить новый пакет или дождаться новой подписки.
404key_not_foundKeysПроверить, что ключ принадлежит текущему пользователю.
429daily_limit_exceededOptimize APIДождаться следующего дня UTC или оплатить пакет.
502converter_unavailableOptimize APIПовторить запрос позже.

Частичные ошибки файлов

В batch-запросе отдельный файл может вернуться с success: false, а общий ответ всё ещё будет содержать результаты по остальным файлам.

{
  "success": true,
  "message": "optimized 1 file(s), 1 failed",
  "results": [
    { "filename": "ok.jpg", "success": true },
    { "filename": "bad.txt", "success": false, "message": "cannot decode image" }
  ]
}