Sign in
V2
Extract
LlamaExtract

Create Extract Job

Create an extraction job.

Extracts structured data from a document using either a saved configuration or an inline JSON Schema.

Input

Provide exactly one of:

  • configuration_id — reference a saved extraction config
  • configuration — inline configuration with a data_schema

Document input

Set document_input_value to a file ID (dfl-...) or a completed parse job ID (pjb-...).

The job runs asynchronously. Poll GET /extract/{job_id} or register a webhook to monitor completion.

post/api/v2/extract

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

document_input_valuestring required

File ID or Parse Job ID to extract from

configuration_idstring nullable

Saved extract configuration ID (mutually exclusive with configuration)

Example request

{
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "document_input_value": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

Response

Successful Response

idstring required

Unique job identifier (job_id)

project_idstring required

Project this job belongs to

configuration_idstring nullable

Saved extract configuration ID used for this job, if any

document_input_valuestring required

File ID or parse job ID that was extracted

statusstring required

Current job status.

  • PENDING — queued, not yet started
  • RUNNING — actively processing
  • COMPLETED — finished successfully
  • FAILED — terminated with an error
  • CANCELLED — cancelled by user
error_messagestring nullable

Error details when status is FAILED

created_atstring date-time required

Creation timestamp

updated_atstring date-time required

Last update timestamp

Example response

{
  "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "document_input_value": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "configuration": {
    "target_pages": "1,3,5-7",
    "max_pages": 10,
    "lang": "en",
    "tier": "cost_effective",
    "extract_version": "latest",
    "extraction_target": "per_doc",
    "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.",
    "parse_tier": "fast",
    "parse_config_id": "cfg-11111111-2222-3333-4444-555555555555"
  },
  "status": "COMPLETED"
}

Changes