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

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

Получить прогон

С output и fields, пока результат хранится (срок хранения результатов организации), затем там null и output_expired: true. Доступ: ключ API со скоупом runs:read или сессия.

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

Авторизация

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

Параметры

обязательный
string
Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

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

Response Body

Прогон

application/json
  1. response
id*string
object*"run"
Value in"run"
status*string
Value in"queued""processing""succeeded""failed"
typizer_id*|

null у прогонов POST /v1/extract

typizer_version*integer|null
mode*string
Value in"standard""precise"
format*string
Value in"json""xml""csv""xlsx"
source*string
Value in"api""my""mcp""demo""agent"
pages*
output?unknown

Извлечённые данные — после успешного завершения

fields*|null
output_expired*boolean
error*|null
file_id*string
file*|null
batch_id*string|null
metadata*
created_at*string
Formatdate-time
completed_at*|
Formatdate-time
curl -X GET 'https://api.typizer.ru/v1/runs/string'
Example Response
{  "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"}

Извлечь данные по разовой схеме

Прогон с разовой схемой, без сохранения типизатора (typizer_id равен null). Схема подчиняется правилам типизатора (см. POST /v1/typizers). Передайте документ ровно одним способом: частью multipart file, полем file_id или url. Тело — JSON или multipart с остальными полями в виде текста (metadata — объект JSON). Страницы резервируются на балансе при создании прогона (402 insufficient_balance, если их не хватает) и списываются при его завершении. Загрузки: не больше 2 одновременно на организацию (429), всё тело за 120 с без пауз дольше 15 с (408). Не больше 20 новых прогонов в секунду на ключ API или пользователя (429; много документов — через пакеты). Поддерживает Idempotency-Key. Доступ: ключ API со скоупом runs:write или сессия.

Скачать результат прогона

Результат успешного прогона в виде файла (Content-Disposition: attachment; filename="<run id>.<ext>"). Столбцы и элементы идут в порядке свойств схемы. csv — один файл или zip из data.csv и отдельного файла на каждое поле-массив. В csv и xlsx текстовое значение, которое таблица могла бы выполнить как формулу (начинается с =, +, -, @, табуляции или перевода строки), записывается с ведущим '. 409, если прогон не завершился успешно; 404 «output expired», когда результат больше не хранится. Файл передаётся потоком по мере формирования (без Content-Length); сбой на середине обрывает передачу, а не завершает её раньше. xlsx отклоняется (413 file_too_large), если в таблице больше строк, чем вмещает лист (1 048 575). Не больше 2 выгрузок одновременно на организацию (429), 503, пока сервер занят; оба ответа с Retry-After. Доступ: ключ API со скоупом runs:read или сессия.