Skip to main content
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

multipart/form-data
model
string
obrigatório

ID do modelo a ser usado para extração

schema
string
obrigatório

Objeto JSON Schema ou string JSON definindo a estrutura dos dados a serem extraídos

file
file
obrigatório

O arquivo para extrair dados estruturados de

metadata
string

Metadados opcionais como objeto JSON ou string JSON

prompt
string

Prompt personalizado opcional para guiar a extração

Resposta

200 - application/json

OK

Resposta do ponto de extração contendo os dados estruturados extraídos e os metadados sobre o processo de extração.

success
boolean
obrigatório

Indica se a solicitação de extração foi bem-sucedida.

metadata
object
obrigatório

Metadados sobre a solicitação e execução da extração

data
any

Os dados estruturados extraídos estão em conformidade com o esquema JSON fornecido. Este é o resultado da análise do arquivo e da extração de informações de acordo com a definição do esquema.