REST API

Кодове на грешки

Всички кодове на грешки, които API връща, с HTTP статус, значение и какво да направите.

Формата на грешката

Грешките са JSON с тази форма. Изграждайте логиката върху code, който никога не се променя; message е за хора и може да се промени. details изброява всяко невалидно поле при 400.

json

{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
    "requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
  }
}

Кодове

Сочете директно към код, като използвате името му като котва, например /docs/api/errors#rate_limited.

400invalid_request: Тялото, заявката или заглавка е невалидна. details посочва всяко поле с проблем. Поправете заявката; изпратена без промяна, тя ще се провали отново.
401api_key_expired: Ключът е изтекъл. Създайте нов ключ или го сменете, за да получите нова тайна.
401api_key_revoked: Ключът е отменен. Създайте нов ключ в Настройки › Разработчици.
401invalid_api_key: Нито един ключ не съвпада. Проверете дали е копиран целият ключ или създайте нов в Настройки › Разработчици.
401unauthorized: Заглавката Authorization липсва или не е думата Bearer, последвана от ключа. Изпращайте ключа като Bearer токен.
402insufficient_credits: ИИ кредитите на собственика на ключа са изчерпани. Заредете или сменете плана в Attorly и опитайте отново.
402usage_limit_exceeded: Достигнато е ограничение за използване на ИИ на собственика на ключа или на организацията. То се нулира с периода на фактуриране; администратор на организацията може да увеличи ограничението на член.
403ai_consent_withdrawn: Собственикът на ключа или на документа е оттеглил съгласието си за обработка с ИИ. То може да бъде дадено отново в настройките за поверителност.
403forbidden: Ключът може да чете ресурса, но не и да го променя, или действието не е разрешено за него. Поискайте от собственика права за редактиране.
403insufficient_scope: На ключа му липсва право, необходимо за тази операция; съобщението го посочва. Създайте ключ с това право.
403ip_not_allowed: Ключът има списък с разрешени IP адреси, а заявката е дошла от адрес извън него. Извикайте от разрешен адрес или променете списъка в Настройки › Разработчици.
403plan_required: Планът на собственика на ключа не включва достъп до API или собственикът е напуснал организацията. Достъпът до API изисква Pro или Enterprise.
404not_found: Ресурсът не съществува или този ключ не може да го види. Проверете идентификатора и дали собственикът на ключа има достъп.
405method_not_allowed: Пътят не поддържа този HTTP метод. Заглавката Allow изброява поддържаните методи.
409conflict: Заявката е в конфликт с текущото състояние на ресурса, например действие, което вече е извършено. Прочетете ресурса и решете отново.
409idempotency_request_in_progress: Заявка със същия Idempotency-Key все още се изпълнява. Проверявайте адреса от заглавката Location или опитайте отново след Retry-After секунди.
413payload_too_large: Тялото или каченият файл е твърде голям. Файловете може да са до 10 MB.
415unsupported_media_type: Тялото е във формат, който тази операция не приема. Изпратете JSON или multipart/form-data, където качването е разрешено.
422idempotency_key_reused: Този Idempotency-Key вече е използван за друга заявка. Използвайте нов ключ за всяка различна заявка.
422unprocessable: Заявката е валидна, но не може да бъде изпълнена, например анализ на документ без избрано приложимо право. Съобщението казва какво липсва.
429concurrency_limit_exceeded: Вашата организация вече изпълнява толкова дълги AI операции едновременно, колкото е позволено. Изчакайте една да приключи или броя секунди от Retry-After и опитайте отново.
429rate_limited: Твърде много заявки в един от прозорците, в които се брои този ключ. Изчакайте броя секунди от Retry-After и опитайте отново. Заглавката RateLimit показва кой прозорец е пълен.
500internal_error: Нещо се обърка в Attorly. Опитайте отново със същия Idempotency-Key; ако проблемът продължи, свържете се с поддръжката и посочете requestId.
504timeout: Операцията не завърши навреме. Опитайте отново със същия Idempotency-Key или изпратете Prefer: respond-async и проверявайте операцията.