Коды ошибок
Таблица всех кодов ошибок API и отдельно — кодов ошибок прогона, со статусами HTTP.
Каждая ошибка API возвращается в формате application/problem+json (RFC 9457) с
машиночитаемым полем code и ссылкой type/doc_url вида
https://docs.typizer.ru/errors/<code> — она открывается и ведёт на страницу этого кода. Какие
именно ответы каждая операция может вернуть — в её собственной странице
«Справочника API».
Прогон (run), завершившийся неудачей, несёт код ошибки в поле run.error.code. У такой ошибки
нет HTTP-статуса — прогон асинхронный. Большинство кодов совпадают с кодами API; timeout —
исключение, которого нет среди кодов API.
Ошибки API
| Код | HTTP-статус | Описание | Повтор |
|---|---|---|---|
invalid_request | 400 | Некорректный запрос | нет |
invalid_id | 400 | Некорректный идентификатор | нет |
invalid_schema | 400 | Некорректная схема | нет |
unsupported_schema_feature | 400 | Неподдерживаемая возможность схемы | нет |
file_too_large | 413 | Файл слишком большой | нет |
unsupported_file_type | 415 | Неподдерживаемый тип файла | нет |
too_many_pages | 400 | Слишком много страниц | нет |
unauthorized | 401 | Не авторизовано | нет |
forbidden | 403 | Доступ запрещён | нет |
insufficient_scope | 403 | Недостаточно прав ключа | нет |
not_found | 404 | Не найдено | нет |
conflict | 409 | Конфликт состояния | нет |
idempotency_conflict | 409 | Конфликт идемпотентности | нет |
insufficient_balance | 402 | Недостаточно баланса | нет |
rate_limited | 429 | Превышен лимит запросов | да |
extraction_failed | 422 | Извлечение не удалось | нет |
document_unreadable | 422 | Документ не читается | нет |
upstream_unavailable | 503 | Сервис обработки временно недоступен | да |
internal_error | 500 | Внутренняя ошибка | да |
Ошибки прогона
Код в поле run.error.code завершившегося прогона. HTTP-статус к нему не относится — прогон асинхронный.
| Код | Описание | Повтор |
|---|---|---|
document_unreadable | Документ не читается | нет |
too_many_pages | Слишком много страниц | нет |
extraction_failed | Извлечение не удалось | нет |
upstream_unavailable | Сервис обработки временно недоступен | да |
internal_error | Внутренняя ошибка | да |
timeout | Истекло время обработки | да |
insufficient_balance | Недостаточно баланса | нет |