import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tables/{table_id}/extractor-table-retrieval/"

payload = {
    "extractor_version_id": "d2846094-89fe-4db9-8f39-14607da40063",
    "filters": { "document_id": "82c71787-37e9-42ca-a995-982e2ed53169" },
    "columns": ["id", "json_object", "object_bbox", "document_id", "min_page", "max_page"],
    "limit": 500,
    "offset": 0
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "result": {
    "results": [
      {}
    ],
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_next": true,
    "has_previous": true
  }
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

{
  "error": "User not found"
}

Tables

Read extractor output rows

Read-only retrieval of rows produced by a specific ExtractorVersion, joining the warehouse table with HydrationComputation records.

What it returns: rows from {table_id} whose computation_hash belongs to a HydrationComputation with the given extractor_version_id (and matching lineage, when provided). By default only rows still considered “live” (deleted IS NULL on the physical table and the hydration computation not soft-deleted) are returned.

Write operations are not supported by this endpoint.

Filtering: Keys are column names with optional Django-style lookups (__in, __gte, __lte, __isnull). The frontend-only key processing_options, if present, is ignored server-side.

Lineage: Optional list of {node_id, computation_hash} entries that narrows results to a specific upstream computation path in the extraction-flow DAG. Omit to retrieve all rows produced by the extractor version.

Permissions: CAN_VIEW_DATA on the project.

POST

projects

{project_id}

tables

{table_id}

extractor-table-retrieval

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tables/{table_id}/extractor-table-retrieval/"

payload = {
    "extractor_version_id": "d2846094-89fe-4db9-8f39-14607da40063",
    "filters": { "document_id": "82c71787-37e9-42ca-a995-982e2ed53169" },
    "columns": ["id", "json_object", "object_bbox", "document_id", "min_page", "max_page"],
    "limit": 500,
    "offset": 0
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "result": {
    "results": [
      {}
    ],
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_next": true,
    "has_previous": true
  }
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

{
  "error": "User not found"
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

table_id

string<uuid>

required

UUID of the table

Body

application/json

extractor_version_id

string<uuid>

required

UUID of the ExtractorVersion whose output rows should be returned. Rows are joined with HydrationComputation records on their computation_hash.

filters

object

Column-level filters. Keys are column names with optional Django-style lookups (e.g. document_id, min_page__gte, max_page__lte, deleted__isnull). The reserved key processing_options (used by the frontend for display only) is stripped server-side.

Example:

{
  "document_id": "82c71787-37e9-42ca-a995-982e2ed53169",
  "min_page__gte": 1,
  "max_page__lte": 1
}

columns

string[]

Column names to return in each row. Omit (or send []) to return every column of the underlying physical table.

Example:

[
  "id",
  "json_object",
  "object_bbox",
  "document_id",
  "min_page",
  "max_page"
]

lineage

object[] | null

Optional list of {node_id, computation_hash} entries restricting the result set to a specific upstream computation path. Send null or omit to retrieve all rows for the extractor version.

Show child attributes

include_deleted_rows

boolean

default:false

When true, also return rows whose HydrationComputation has been soft-deleted (deleted_at IS NOT NULL) and rows where the table's deleted flag is set. Defaults to false.

limit

integer

default:100

Maximum number of rows to return.

offset

integer

default:0

Number of rows to skip for pagination.

Response

Rows retrieved successfully

Wrapper around the paginated list of rows produced by the requested ExtractorVersion.

result

object

Show child attributes

Concepts

Endpoints

Read extractor output rows

Authorizations

Path Parameters

Body

Response