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

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

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

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

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

Авторизация

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

Параметры

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

Тело запроса

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

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

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

Request Body

application/json
  1. body
name?string
Length1 <= length <= 120
description?|
Lengthlength <= 1000
schema?

Подмножество JSON Schema (draft 2020-12) с корнем object: не больше 200 полей и 10 уровней схемы (core), 131072 байт (128 КиБ) в компактном JSON в UTF-8, 64 уровней вложенности JSON (включая examples), и ни в одной строке нет NUL или непарного суррогата. Имена полей — буквы, десятичные цифры, _ и -, начинаются с буквы или _ (они становятся именами элементов XML). Порядок properties сохраняется: по нему идут столбцы результата, элементы XML и XSD.

instructions?string

Дополнительные указания для извлечения, передаются модели вместе со схемой

Lengthlength <= 4000
default_format?string

Формат выгрузки прогона, если формат не указан

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

precise перепроверяет извлечение (оплачивается больше страниц)

Value in"standard""precise"

Response Body

Типизатор после изменения

application/json
  1. response
id*string
object*"typizer"
Value in"typizer"
name*string
description*string|null
version*integer

Текущая версия

schema*

Схема текущей версии

instructions*string
default_format*string

Формат выгрузки прогона, если формат не указан

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

precise перепроверяет извлечение (оплачивается больше страниц)

Value in"standard""precise"
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X PATCH 'https://api.typizer.ru/v1/typizers/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "object": "typizer",  "name": "string",  "description": "string",  "version": 0,  "schema": {    "property1": null,    "property2": null  },  "instructions": "string",  "default_format": "json",  "mode": "standard",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Список типизаторов, новые первыми

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

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

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