Skip to main content
POST
Extract

Authorizations

Authorization
string
header
required

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

Body

application/json
input
required

For parse/split/extract pipelines, the URL of the document to be processed. You can provide one of the following: 1. A publicly available URL 2. A presigned S3 URL 3. A reducto:// prefixed URL obtained from the /upload endpoint after directly uploading a document 4. A jobid:// prefixed URL obtained from a previous /parse invocation 5. A list of URLs (for multi-document pipelines, V3 API only)

parsing
ParseOptions · object

The configuration options for parsing the document. If you are passing in a jobid:// URL for the file, then this configuration will be ignored.

instructions
Instructions · object

The instructions to use for the extraction.

settings
ExtractSettings · object

The settings to use for the extraction.

Response

Successful Response

usage
ExtractUsage · object
required
result
required

The extracted response in your provided schema. This is a list of dictionaries. If disable_chunking is True (default), then it will be a list of length one.

response_type
string
default:v3_extract
Allowed value: "v3_extract"
job_id
string | null

The link to the studio pipeline for the document.

confidence
enum<string> | null

Optional document-level deep extract confidence label.

Available options:
high,
low
confidence_reason
string | null

Optional explanation for the document-level confidence label.