V2
Extract

List Extract Jobs

Changed on

List extraction jobs with optional filtering and pagination.

Filter by configuration_id, status, file_input, or creation date range. Results are returned newest-first. Use expand=configuration to include the full configuration used, and expand=extract_metadata for per-field metadata.

get/api/v2/extract

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

document_input_typestring nullable

Filter by document input type (file_id or parse_job_id)

file_inputstring nullable

Filter by file input value

document_input_valuestring nullable

Deprecated: use file_input instead

status'PENDING' | 'THROTTLED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' nullable

Filter by status

page_sizeinteger nullable

Number of items per page

page_tokenstring nullable

Token for pagination

job_idsstring[] nullable

Filter by specific job IDs

expandstring[]

Additional fields to include: configuration, extract_metadata

project_idstring uuid nullable
organization_idstring uuid nullable
configuration_idstring nullable

Filter by configuration ID

Example:cfg-11111111-2222-3333-4444-555555555555
created_at_on_or_afterstring date-time nullable

Include items created at or after this timestamp (inclusive)

created_at_on_or_beforestring date-time nullable

Include items created at or before this timestamp (inclusive)

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "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
            }
          }
        }
      }
    }
  ]
}

Changes

  • b17341164de9Revision changes
    • info

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

    • info

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

  • d40e17e17bd1Revision changes
    • warning

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

    • info

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