job_id immediately, and retrieve the result when the job completes.
Use Extract Jobs for long-running extractions, such as extracting from long documents or with large, complex schemas.
Endpoints
The request fields are the same as the synchronous Extract API. See Extract Input Parameters. Extract Jobs uses these endpoints:| Method | Endpoint | Purpose |
|---|---|---|
| POST | /v2/extract/jobs | Create an extract job. |
| GET | /v2/extract/jobs/{job_id} | Get the status and result of a job. |
Workflow
- Build your extraction schema. See Extraction Schema (JSON).
- Submit the Markdown and schema to
POST /v2/extract/jobs. - Get the
job_idfrom the response. - Poll
GET /v2/extract/jobs/{job_id}untilstatusiscompleted. - Read the extracted fields from the job’s
result. See Extract API Response.
Create a Job
Send the same fields you would send to the synchronous endpoint. ReplaceYOUR_API_KEY with your API key and parse-output.md with the path to your Markdown file.
202 response with the job_id and the initial status:
Choose a Service Tier
Set the optionalservice_tier form field to control the job’s turnaround time and credit consumption. If you omit service_tier, the job runs on the standard tier. For credit consumption by tier, see Credit Consumption.
| Tier | Behavior |
|---|---|
standard | Consumes half the credits of the priority tier, with a slower turnaround. Best for cost-sensitive or non-urgent workloads. |
priority | Consumes credits at the full rate, the same as synchronous extraction, with a faster turnaround. Best for time-sensitive jobs. |
service_tier field in your create-job request:
Get a Job
Poll the job with itsjob_id:
| Field | Description |
|---|---|
job_id | The unique identifier for the job. |
status | The current state of the job. See Job Statuses. |
created_at | When the job was created. |
completed_at | When the job finished. Present once the job reaches a final state. |
progress | How far the job has progressed, from 0 to 1. Present while the job is processing. |
result | The extraction result, present when status is completed. This object has the same shape as a synchronous response. See Extract API Response. |
error | Present when status is failed. Contains a code and a message. |
Job Statuses
| Status | Description |
|---|---|
pending | The job is accepted and queued, but has not started. |
processing | The job is running. |
completed | The job finished. Read the extraction from the result field. |
failed | The job did not finish. See the error field for details. |