Extract structured data
Fills a JSON Schema from the text. Supports strings, numbers, booleans, enums, string arrays and nested objects. Arrays of objects are accepted and returned empty. Missing values are null. On an image the vision model fills the schema itself, arrays of objects included; the schema may ask for at most 5 fields (image_schema_too_large), because a generative pass over a photo is for a handful of values, not a page.
Send text for one result, texts for a batch wrapped as { results: [...] }, or image (one image, at most 5 MB decoded, optionally with text; never with texts). The response carries x-input-chars (input characters) and x-input-tokens (input tokens billed for this call) headers. Each item of texts (and each of statements or questions) counts as one request against the requests-per-minute limit.
Authentication
A milliseconds API key, test_sk-{namespace}-{entropy} or prod_sk-{namespace}-{entropy}. Every /v1 route requires it.
Request
Batch form: one result per text.
One image: a data:image/(jpeg|png|webp);base64, URL, or bare base64 of a JPEG, PNG or WebP. 5 MB decoded at most. URLs are never fetched. May travel with text (extra context), never with texts.
Image resolution: low 512 px, medium 768 px (default), high 1024 px longest edge. Higher sees more and bills more.
Response
Result, or { results } for a batch