Skip to content

Endpoint

POST /v1/

Extract structured data from documents and images using AI-powered parsing.

ParameterTypeRequiredDescription
schemaobjectYesJSON schema defining the data structure to extract
contentsarrayYesArray of files to process

Each item in the contents array must contain:

FieldTypeRequiredDescription
filenamestringNoOptional filename
mimeTypestringYesMIME type of the file
datastringYesBase64-encoded file data
  • image/jpeg - JPEG images
  • image/png - PNG images
  • image/webp - WebP images
  • image/gif - GIF images
  • application/pdf - PDF documents
{
"schema": {
"type": "object",
"properties": {
"invoice_number": {
"type": "string",
"description": "Unique invoice identifier, often prefixed with 'INV-' or similar"
},
"total_amount": {
"type": "number",
"description": "Final amount due including all taxes and fees"
},
"date": {
"type": "string",
"description": "Invoice date in YYYY-MM-DD format"
}
}
},
"contents": [
{
"filename": "receipt.pdf",
"mimeType": "application/pdf",
"data": "JVBERi0xLjQKJcOkw7zDtsO..."
}
]
}

Returns extracted data as JSON matching your provided schema:

{
"invoice_number": "INV-2024-001",
"total_amount": 1250.5,
"date": "2024-01-15"
}
Status CodeDescription
400Bad Request - Invalid request format
401Unauthorized - Invalid or missing API key
500Internal Server Error - Server processing error