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

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

Список прогонов, новые первыми

Пагинация по курсору, новые первыми. В списке output и fields всегда null (output_expired всё равно показывает, хранится ли результат); за ними запросите прогон или его /output. Доступ: ключ API со скоупом runs:read или сессия.

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

Авторизация

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

Параметры

integer1–100по умолчанию 20

Элементов на странице, 1–100

string

next_cursor предыдущей страницы: список продолжается после этого идентификатора

string

Только прогоны в этом статусе

string≤ 64 симв.

Только прогоны этого типизатора

string≤ 64 симв.

Только прогоны этого пакета

string

Откуда запущен прогон

string · date-time

Только прогоны, созданные позже этого момента (не включая его)

string · date-time

Только прогоны, созданные раньше этого момента (не включая его)

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

Authorization

headerAuthorizationBearer <token>

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

Query Parameters

limit?integer

Элементов на странице, 1–100

Range1 <= value <= 100
Default20
starting_after?string

next_cursor предыдущей страницы: список продолжается после этого идентификатора

status?string
Value in"queued""processing""succeeded""failed"
typizer_id?string
Lengthlength <= 64
batch_id?string
Lengthlength <= 64
source?string
Value in"api""my""mcp""demo""agent"
created_after?string

Только прогоны, созданные позже этого момента (не включая его)

Formatdate-time
created_before?string

Только прогоны, созданные раньше этого момента (не включая его)

Formatdate-time

Header Parameters

Typizer-Organization?string

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

Response Body

Страница прогонов

application/json
  1. response
object*"list"
Value in"list"
data*array<>
has_more*boolean
next_cursor*string|null
curl -X GET 'https://api.typizer.ru/v1/runs'
Example Response
{  "object": "list",  "data": [    {      "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"    }  ],  "has_more": true,  "next_cursor": "string"}

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

Результат успешного прогона в виде файла (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 или сессия.

Повторить неудачный прогон

Создаёт новый прогон с версией типизатора неудачного прогона (даже если типизатор с тех пор изменён или удалён) или его разовой схемой и инструкциями, файлом, format, mode и metadata, а также его webhook_url, пока у активной конечной точки вебхуков есть этот URL (но не у отключённой вами). Страницы резервируются как для любого прогона (402 insufficient_balance). 409, если прогон не завершился неудачей, если его файл больше не хранится («source file expired») или если прогон сделан ассистентом (запустите его снова из ассистента). Входит в лимит новых прогонов (20 в секунду на ключ API или пользователя, 429). Поддерживает Idempotency-Key; передавайте его: каждый вызов без ключа создаёт ещё один прогон и резервирует под него страницы. Доступ: ключ API со скоупом runs:write или сессия.