Skip to main content
POST
Extract structured data from a document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Body for POST /api/v3/extract.

schema is the JSON Schema that drives extraction. It arrives as a dict on JSON requests and as a JSON-encoded string on multipart requests — both are coerced to dict.

options is a free-form dict; currently supports {"async": bool}.

schema
Schema · object
required
document
string | null
file_id
integer | null
options
Options · object

Response

Extraction completed (sync mode).

id
string
required
status
string
required
created_at
string<date-time> | null
completed_at
string<date-time> | null
processing_time_ms
integer | null
document
ExtractDocument · object | null
result
ExtractResult · object | null
usage
ExtractUsage · object | null
progress
JobProgress · object | null

Live progress of a long-running async job while it is in flight.

Shared by the parse (GET /api/v3/parse/<id>) and extract (GET /api/v3/extract/<id>) polling envelopes: pages_processed is the count of pages done so far and percentage is the completion percentage [0, 100] derived from it.