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

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

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

Передайте документ ровно одним способом: частью 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 или сессия.

Claude (откроется в новой вкладке)ChatGPT (откроется в новой вкладке)
POST/v1/typizers/{id}/runsПесочница

Авторизация

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

Прогоны из песочницы тарифицируются как обычные

Одна отметка — одна отправка.

Параметры

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

Сколько секунд (0–60) держать запрос до завершения прогона: 200 с завершённым прогоном или 202 с его текущим состоянием, когда время вышло.

Документ

Откуда взять документ

Тело запроса

application/json
Проверяем сессию Кабинета…Idempotency-Key — новый на каждую отправку

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

Query Parameters

wait?|

Сколько секунд (0–60) держать запрос до завершения прогона: 200 с завершённым прогоном или 202 с его текущим состоянием, когда время вышло. Если при создании прогона очередь была ненадолго недоступна, прогон автоматически ставится в очередь снова и стартует примерно в течение 15 минут; ожидание тогда просто заканчивается ответом 202.

Range0 <= value <= 60

Header Parameters

Typizer-Organization?string

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

Idempotency-Key?string

1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (Idempotent-Replayed: true); тот же ключ с другим запросом или пока первый ещё выполняется — 409 idempotency_conflict.

Match^[\x20-\x7E]+$
Length1 <= length <= 255

Request Body

  1. body
file_id?string

Файл, загруженный через POST /v1/files

Lengthlength <= 64
url?string

Публичный URL http(s), с которого скачать документ (не больше 50 МиБ, 30 с)

Lengthlength <= 2048
webhook_url?string

Публичный URL https, на который придёт вебхук run.succeeded/run.failed этого прогона. Если у организации нет конечной точки с этим URL, она создаётся (без подписки на другие события). 409 conflict, если конечная точка организации с этим URL отключена: включите её снова, чтобы использовать.

Lengthlength <= 2048
metadata?

Ваши собственные пары ключ/значение; возвращаются с прогоном и в его вебхуках: не больше 20 ключей длиной 1–40 символов, строковые значения не длиннее 500 символов

format?string

По умолчанию — default_format типизатора

Value in"json""xml""csv""xlsx"
mode?string

По умолчанию — mode типизатора

Value in"standard""precise"

Response Body

Прогон завершился в пределах wait

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 POST 'https://api.typizer.ru/v1/typizers/string/runs' \  -H 'Content-Type: application/json' \  -d '{}'
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"}

Изменить типизатор

Версии неизменяемы: изменённые schema или instructions создают новую версию, и она становится текущей. Перестановка поля внутри properties — это изменение (порядок полей — порядок результата); перестановка ключевого слова внутри поля — нет. Остальные поля меняются на месте. Доступ: ключ API со скоупом typizers:write или сессия.

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

Прогон с разовой схемой, без сохранения типизатора (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 или сессия.