Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
СправочникСправочник APIПакеты

Скачать результаты пакета

Результаты успешных прогонов пакета, которые ещё хранятся, в порядке создания прогонов (Content-Disposition: attachment; filename="<batch id>.<ext>"). csv — одна таблица со столбцом run_id или zip из data.csv и отдельного файла на каждое поле-массив; xlsx — то же в виде листов; zip — по одному <run id>.json на прогон. В csv и xlsx текстовое значение, которое таблица могла бы выполнить как формулу, записывается с ведущим '. 409, пока пакет обрабатывается. Передаётся потоком по мере формирования (без Content-Length); сбой на середине обрывает передачу, а не завершает её раньше. xlsx отклоняется (413), если в таблице больше строк, чем вмещает лист. Не больше 2 выгрузок одновременно на организацию (429), 503, пока сервер занят; оба ответа с Retry-After. Доступ: ключ API со скоупом runs:read или сессия.

GET/v1/batches/{id}/exportПесочница

Авторизация

Проверяем сессию Кабинета…

Параметры

обязательный
string
string

Формат выгрузки

Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.

Path Parameters

id*string

Query Parameters

format*string
Value in"csv""xlsx""zip"

Header Parameters

Typizer-Organization?string

Организация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.

Response Body

Выгрузка

response?file
Formatbinary
curl -X GET 'https://api.typizer.ru/v1/batches/string/export?format=csv'
Example Response
"string"

Запустить типизатор на многих документах

Один прогон на файл, у всех одна версия типизатора, format, mode и metadata: JSON с file_ids или multipart с частями files (одна из них может быть .zip). Сначала страницы всех прогонов сверяются с балансом (402 insufficient_balance, ничего не создаётся), затем резервируются по прогону. Всё или ничего: если прогон создать не удаётся (например, 402, потому что страницы тем временем израсходованы), запрос завершается этой ошибкой, ничего из пакета не запускается, а страницы возвращаются; уже созданные прогоны остаются в списке как неудачные в пакете completed. Пакет завершается, когда закончены все прогоны (вебхук batch.completed). Не больше 500 документов (.zip считается по числу файлов). Загрузки: не больше 2 одновременно на организацию (429), тело с .zip занимает обе; всё тело за 100 с без пауз дольше 15 с (408). На весь запрос — 100 с: пакет, который не удалось сохранить за это время, отклоняется с 503 «batch too large to process in one request; split it», и ничего из него не сохраняется. Поддерживает Idempotency-Key; повтор пакета, который из-за обрыва получил меньше прогонов, чем было прислано, — 409 conflict «batch was only partially created; create a new batch for the remaining documents» с batch_id, created и expected. Не больше 2 пакетов в секунду и 60 в минуту на ключ API или пользователя (429). Доступ: ключ API со скоупом runs:write или сессия.

Получить пакет

Доступ: ключ API со скоупом runs:read или сессия.