POST /api/v1/recognize

Формат запроса и ответа основного метода распознавания.

Метод
POST https://devmoon.ru/api/v1/recognize

Тело запроса — multipart/form-data.

Параметры#

Параметр

Тип

Обязательный

Описание

file

файл

Да

Изображение документа: JPG, PNG, WebP, HEIC или HEIF, не больше 15 МБ.

transactionId

строка

Нет

Ключ идемпотентности списания. Можно передать вместо него заголовок x-idempotency-key.

Ответ#

Поле

Тип

Описание

documents

массив

Найденные на изображении документы.

documents[].type

строка

Тип распознанного документа.

documents[].fields

объект

Извлечённые поля: имена полей зависят от типа документа, значения — строки.

remaining

число

Остаток лимита после списания.

Документы не найдены
{
  "documents": [],
  "remaining": 250
}

Ограничение частоты#

Не более 5 запросов в секунду на одну лицензию. Превышение возвращает 429 — повторите запрос позже.