GET
/
v1
/
projects
from retab import Retab

client = Retab()
response = client.projects.list()
{
  "data": [
    {
      "id": "<string>",
      "name": "",
      "json_schema": {},
      "default_inference_settings": {
        "model": "gpt-4.1-mini",
        "temperature": 0,
        "modality": "native",
        "reasoning_effort": "medium",
        "image_resolution_dpi": 96,
        "browser_canvas": "A4",
        "n_consensus": 1
      },
      "updated_at": "2023-11-07T05:31:56Z",
      "documents": [
        {
          "mime_data": {
            "filename": "file.pdf",
            "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..."
          },
          "annotation": {},
          "annotation_metadata": {
            "extraction_id": "<string>",
            "likelihoods": {},
            "field_locations": {},
            "agentic_field_locations": {},
            "consensus_details": [
              {}
            ],
            "api_cost": {
              "value": 123,
              "currency": "<string>"
            }
          },
          "id": "<string>",
          "ocr_file_id": "<string>"
        }
      ],
      "iterations": [
        {
          "id": "<string>",
          "inference_settings": {
            "model": "<string>",
            "temperature": 123,
            "modality": "text",
            "reasoning_effort": "low",
            "image_resolution_dpi": 123,
            "browser_canvas": "A3",
            "n_consensus": 123
          },
          "json_schema": {},
          "updated_at": "2023-11-07T05:31:56Z",
          "predictions": {}
        }
      ],
      "schema_data_id": "<string>",
      "schema_id": "<string>"
    }
  ],
  "list_metadata": {
    "before": "<string>",
    "after": "<string>"
  }
}
from retab import Retab

client = Retab()
response = client.projects.list()

Authorizations

Api-Key
string
header
required

Query Parameters

before
string | null
after
string | null
limit
integer
default:10
order
enum<string>
default:desc
Available options:
asc,
desc
fields
string | null
schema_id
string | null
schema_data_id
string | null

Response

200
application/json

Successful Response

The response is of type object.