V2
Extract

Get Extract Job

Changed on

Get a single extraction job by ID.

Returns the job status and results when complete. Use expand=configuration to include the full configuration used, expand=extract_metadata for per-field metadata, and expand=usage for credits billed against the job.

get/api/v2/extract/{job_id}

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v2/extract/{job_id}
  • Auth: HTTP bearer

Path parameters

job_idstring required

Query parameters

expandstring[]

Additional fields to include: configuration, extract_metadata, usage

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

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",
    "disable_cache": true,
    "extraction_target": "per_doc",
    "system_prompt": "Extract all monetary values in USD. If a currency is not specified, assume USD.",
    "spreadsheet_mode": true,
    "sheet_names": [
      "Sheet 1",
      "Q4 Summary"
    ],
    "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": [
            {
              "bounding_boxes": [
                {
                  "h": 14,
                  "w": 120,
                  "x": 72,
                  "y": 96
                }
              ],
              "matching_text": "Noisebridge",
              "page": 1
            }
          ],
          "confidence": 1,
          "extraction_confidence": 1,
          "parsing_confidence": 1
        }
      }
    }
  },
  "usage": {
    "credits": 30,
    "extract_credits": 45,
    "parse_credits": 30
  }
}

Changes

  • a38b684f8e1bRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      added the new agentic enum value to the /// response property for the response status

    • warning

      added the new agentic_plus enum value to the /// response property for the response status

    • warning

      added the new agentic_plus enum value to the // response property for the response status

    • warning

      added the new cost_effective enum value to the /// response property for the response status

    • warning

      added the new fast enum value to the /// response property for the response status

    • warning

      added the new turbo enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status