Skip to main content
POST
Run Extract

Authorizations

x-api-key
string
header
required

Headers

Pulse-Version
string
default:2

Body

application/json

A completed parse to extract from, and the options to extract with.

parse_id
string
required

The parse_id of a completed parse whose result hasn't expired.

Minimum string length: 1
config
ExtractConfig { page_range, prompt, input_schema, 3 more } · object
required

This request's options.

async
boolean
default:false

Set to true to return 202 at once instead of waiting.

Response

The extraction completed. Read its data at GET /extract/{extract_id}/result.

A completed extraction. Read its data at GET /extract/{extract_id}/result.

extract_id
string
required

The extraction's id, extract-<uuid>.

created_at
string
required

When the job was created.

completed_at
string
required

When the job ended.

expires_at
string

When the result will be deleted. Absent when the result is kept with no expiry.