Get Extraction

Get an extraction by ID (job ID) within the specified project.

Args: project_id: Project ID that the extraction belongs to extraction_id: Extraction ID (job ID) to retrieve

Returns: ExtractionEntity: The extraction details

Raises: HTTPException: If project or extraction not found, or extraction doesn’t belong to project

GET /v1/projects/{project_id}/extract/{extraction_id}/result

Get Extraction

cURL

curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/extract/{extraction_id}/result \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'

200

{
  "id": "<string>",
  "project_id": "<string>",
  "source_id": "<string>",
  "result": {
    "data": {
      "invoice_id": {
        "citations": [
          {
            "bbox": {
              "height": 0.2058080808080808,
              "left": 0.07761437908496732,
              "top": 0.42045454545454547,
              "width": 0.8415032679738562
            },
            "content": "INV-2023-001",
            "page": 1
          }
        ],
        "confidence": 0.95,
        "value": "INV-2023-001"
      },
      "total_amount": {
        "citations": [
          {
            "bbox": {
              "height": 0.2058080808080808,
              "left": 0.07761437908496732,
              "top": 0.42045454545454547,
              "width": 0.8415032679738562
            },
            "content": "119.99",
            "page": 1
          }
        ],
        "confidence": 0.95,
        "value": 119.99
      }
    }
  },
  "parameters": {
    "model": "<string>",
    "extraction_schema": {},
    "model_kwargs": {},
    "system_prompt": "<string>",
    "user_prompt": "<string>",
    "generate_citations": true,
    "generate_confidence": true,
    "use_agentic": false,
    "agentic_tools": {},
    "execute_dependent_subtask_tool_hints": false,
    "agent_settings": {
      "use_agentic": false,
      "planning_model": "<string>",
      "acting_model": "<string>",
      "reflection_model": "<string>",
      "max_turns": 2,
      "max_context_tokens": 100000,
      "max_reasoning_hops": 123,
      "max_waves": 123,
      "max_validation_fix_attempts": 2,
      "decompose_prompt_template": "<string>",
      "decompose_rules": "<string>",
      "search_rules": "<string>",
      "extraction_rules": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "object": "extraction",
  "processing_time_ms": 123
}

Authorizations

x-api-key · string · header · required

API key for authentication

x-selected-account-id · string · header · required

Selected Account ID

Path Parameters

project_id · string · required

extraction_id · string · required

Response

200

application/json

Successful Response

Extraction result response model.

id · string · required

ID of the entity

project_id · string · required

ID of the project

source_id · string · required

Source ID that was extracted from

result · ExtractionResult · object · required

The extraction result

Show child attributes

Example:

{
  "data": {
    "invoice_id": {
      "citations": [
        {
          "bbox": {
            "height": 0.2058080808080808,
            "left": 0.07761437908496732,
            "top": 0.42045454545454547,
            "width": 0.8415032679738562
          },
          "content": "INV-2023-001",
          "page": 1
        }
      ],
      "confidence": 0.95,
      "value": "INV-2023-001"
    },
    "total_amount": {
      "citations": [
        {
          "bbox": {
            "height": 0.2058080808080808,
            "left": 0.07761437908496732,
            "top": 0.42045454545454547,
            "width": 0.8415032679738562
          },
          "content": "119.99",
          "page": 1
        }
      ],
      "confidence": 0.95,
      "value": 119.99
    }
  }
}

parameters · ExtractionParameters · object · required

Parameters used for extraction

Show child attributes

created_at · string<date-time> · required

When the extraction was completed

object · string · default: extraction

Allowed value: "extraction"

processing_time_ms · integer | null

Processing time in milliseconds