Skip to main content
POST
Fill a schema from an uploaded document

Authorizations

X-API-KEY
string
header
required

Body

multipart/form-data
file
file
required

PDF, PPTX, DOCX, or image (PNG, JPEG, WebP, TIFF, HEIC/HEIF, BMP) document.

schema
string | null

User JSON schema as a JSON string; omit when auto_schema=true.

strict
boolean
default:true

What happens to a value whose citation cannot be verified against the document. true (default): the value is nulled out and its path listed in ungrounded_fields, so a fabricated value never reaches you. false: the value is kept but still flagged in ungrounded_fields.

extract_images
boolean
default:true

Include figures from the parse stage in the extraction context. Set false to extract from text and tables only.

auto_schema
boolean
default:false

Set true (and omit schema) to have a schema designed from the document first, then filled with the same grounded extraction. The schema used is returned in generated_schema.

include_ocr_text
boolean
default:false

false (default): response unchanged. true: additionally return ocr_text — the whole parsed document as a single text string in reading order, the same text POST /v1/parse returns as content.

Response

Successful Response

values
Values · object
required
evidence
Evidence · object
required
page_count
integer
required
ungrounded_fields
string[]
generated_schema
Generated Schema · object | null
usage
BillingUsage · object | null

What this request charged, in credits (plan 078 D6).

Present only on responses whose request was actually charged — absent (never null) on unbilled lanes (demo, legacy-PHI ledger) so pre-credits response shapes stay byte-identical. credits = pages × credits_per_page at the v1 card: parse 1.0, schema extract 4.0 all-in.

ocr_text
string | null