GET
/
v1
/
projects
/
{project_id}
/
documents
from retab import Retab

client = Retab()
response = client.projects.documents.list("<project_id>")

{
  "data": [
    {
      "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>"
    }
  ]
}
from retab import Retab

client = Retab()
response = client.projects.documents.list("<project_id>")

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
project_id
string
required

Query Parameters

​
filename
string | null

Filter documents by filename

Response

200
application/json

Successful Response

The response is of type object.