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 file_input 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.

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

Request body

configuration_idstring nullable

Saved configuration ID

file_inputstring required

File ID or parse job ID to extract from

Example request

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

Response

Successful Response

file_inputstring required

File ID or parse job ID that was extracted

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

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

{
  "file_input": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "id": "ext-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "project_id": "prj-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "configuration_id": "cfg-11111111-2222-3333-4444-555555555555",
  "configuration": {
    "target_pages": "1,3,5-7",
    "max_pages": 10,
    "tier": "cost_effective",
    "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",
  "extract_metadata": {
    "field_metadata": {
      "document_metadata": {
        "items": [
          {
            "amount": {
              "citation": [
                {
                  "matching_text": "$10.00",
                  "page": 1
                }
              ],
              "confidence": 1
            },
            "description": {
              "citation": [
                {
                  "matching_text": "$10/month",
                  "page": 1
                }
              ],
              "confidence": 0.998
            }
          }
        ],
        "total": {
          "citation": [
            {
              "matching_text": "$10.00",
              "page": 1
            }
          ],
          "confidence": 1
        },
        "vendor": {
          "citation": [
            {
              "matching_text": "Noisebridge",
              "page": 1
            }
          ],
          "confidence": 1,
          "extraction_confidence": 1,
          "parsing_confidence": 1
        }
      }
    }
  }
}

v34