Skip to main content
GET
/
v1
/
projects
/
{project_id}
/
extract
/
results
List Extractions
curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/extract/results \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'
{
  "items": [
    {
      "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
      },
      "created_at": "2023-11-07T05:31:56Z",
      "object": "extraction",
      "processing_time_ms": 123
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

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

Query Parameters

​
ids
string[] | null

Filter by extraction IDs (job IDs)

​
created_at_start
string<date-time> | null

Filter by creation time (start)

​
created_at_end
string<date-time> | null

Filter by creation time (end)

​
completed_at_start
string<date-time> | null

Filter by completion time (start)

​
completed_at_end
string<date-time> | null

Filter by completion time (end)

​
source_id
string | null

Filter by source ID (parse result ID or vector store ID)

​
page_size
integer | null

Number of items per page

Required range: 1 <= x <= 100
​
sort_by
string | null

Field to sort by

​
sort_order
enum<string> | null

Sort order (asc or desc) Enum for project sort fields. Note that only non-nullable fields can be sorted by (for details, see: https://github.com/djrobstep/sqlakeyset?tab=readme-ov-file#limitations ).

Available options:
asc,
desc
​
continuation_token
string | null

Pagination token

Response

Successful Response

​
items
ExtractionEntity · object[]
required
​
total_count
integer
required
​
next_token
string | null
​
prev_token
string | null