Saltar al contenido principal
POST
Typescript (SDK)

Autorizaciones

Authorization
string
header
requerido

Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie.

Encabezados

X-On-Behalf-Of
string

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

Cuerpo

multipart/form-data
model
string
requerido

ID del modelo a utilizar para la extracción

schema
string
requerido

Objeto JSON Schema o cadena JSON que define la estructura de datos a extraer

file
file
requerido

El archivo del que extraer datos estructurados

metadata
string

Metadatos opcionales como objeto JSON o cadena JSON

prompt
string

Indicaciones personalizadas opcionales del sistema para guiar la extracción

Respuesta

200 - application/json

Está bien

Respuesta del punto final de extracción que contiene los datos estructurados extraídos y los metadatos sobre el proceso de extracción.

success
boolean
requerido

Indica si la solicitud de extracción fue exitosa.

metadata
object
requerido

Metadatos sobre la solicitud de extracción y la ejecución

data
any

Los datos estructurados extraídos que cumplen con el esquema JSON proporcionado. Este es el resultado de analizar el archivo y extraer información de acuerdo con la definición del esquema.