Повторить неудачный прогон
Создаёт новый прогон с версией типизатора неудачного прогона (даже если типизатор с тех пор изменён или удалён) или его разовой схемой и инструкциями, файлом, format, mode и metadata, а также его webhook_url, пока у активной конечной точки вебхуков есть этот URL (но не у отключённой вами). Страницы резервируются как для любого прогона (402 insufficient_balance). 409, если прогон не завершился неудачей, если его файл больше не хранится («source file expired») или если прогон сделан ассистентом (запустите его снова из ассистента). Входит в лимит новых прогонов (20 в секунду на ключ API или пользователя, 429). Поддерживает Idempotency-Key; передавайте его: каждый вызов без ключа создаёт ещё один прогон и резервирует под него страницы. Доступ: ключ API со скоупом runs:write или сессия.
AuthorizationBearer <token>Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.
id*stringTypizer-Organization?stringОрганизация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
Idempotency-Key?string1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (Idempotent-Replayed: true); тот же ключ с другим запросом или пока первый ещё выполняется — 409 idempotency_conflict.
^[\x20-\x7E]+$1 <= length <= 255Новый прогон в очереди
application/json- response
id*stringobject*"run""run"status*string"queued""processing""succeeded""failed"typizer_id*|null у прогонов POST /v1/extract
typizer_version*integer|nullmode*string"standard""precise"format*string"json""xml""csv""xlsx"source*string"api""my""mcp""demo""agent"pages*output?unknownИзвлечённые данные — после успешного завершения
fields*|nulloutput_expired*booleanerror*|nullfile_id*stringfile*|nullbatch_id*string|nullmetadata*created_at*stringdate-timecompleted_at*|date-timecurl -X POST 'https://api.typizer.ru/v1/runs/string/retry'{ "id": "string", "object": "run", "status": "queued", "typizer_id": "string", "typizer_version": 0, "mode": "standard", "format": "json", "source": "api", "pages": { "physical": 0, "billed": 0 }, "output": null, "fields": { "property1": null, "property2": null }, "output_expired": true, "error": { "code": "string", "message": "string" }, "file_id": "string", "file": { "filename": "string", "mime": "string" }, "batch_id": "string", "metadata": { "property1": "string", "property2": "string" }, "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z"}Список прогонов, новые первыми
Пагинация по курсору, новые первыми. В списке output и fields всегда null (output_expired всё равно показывает, хранится ли результат); за ними запросите прогон или его /output. Доступ: ключ API со скоупом runs:read или сессия.
Запустить типизатор на многих документах
Один прогон на файл, у всех одна версия типизатора, 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 или сессия.