Pular para o conteúdo principal
POST
Python (SDK)

Autorizações

Authorization
string
header
obrigatório

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cabeçalhos

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Corpo

application/json

Definição de esquema para criar um modelo de extração reutilizável. Esquemas de extração definem a estrutura e as regras de validação para a extração de dados de arquivos.

name
string
obrigatório

Nome do esquema de extração. Deve ter entre 1 e 100 caracteres. Usado para identificar e referenciar o esquema.

Required string length: 1 - 100
schema
object
obrigatório

Objeto JSON Schema definindo a estrutura dos dados a serem extraídos. Especifica os campos, tipos e regras de validação para os dados extraídos.

description
string

Descrição opcional do esquema. Máximo de 500 caracteres. Ajuda a documentar o propósito e o uso do esquema.

Maximum string length: 500
metadata
object

Metadados opcionais para o esquema. Podem armazenar informações adicionais como versão, autor ou propriedades personalizadas.

Resposta

200 - application/json

OK

Resposta da criação de um novo esquema de extração.

success
boolean
obrigatório

Indica se a criação do esquema foi bem-sucedida

data
object
obrigatório

O esquema de extração criado com ID gerado e timestamps.