from retab import Retab
client = Retab()
response = client.projects.get("<project_id>")
{
"id": "<string>",
"name": "",
"json_schema": {},
"updated_at": "2023-11-07T05:31:56Z",
"sheets_integration": {
"sheet_id": "<string>",
"spreadsheet_id": "<string>"
},
"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": [
{}
]
},
"playground_extraction": {},
"playground_extraction_metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
]
},
"id": "<string>",
"ocr_file_id": "<string>"
}
],
"iterations": [
{
"id": "<string>",
"parent_id": "<string>",
"inference_settings": {
"model": "gpt-5-mini",
"temperature": 0,
"reasoning_effort": "minimal",
"image_resolution_dpi": 96,
"browser_canvas": "A4",
"n_consensus": 1
},
"schema_overrides": {
"descriptionsOverride": {},
"reasoningPromptsOverride": {}
},
"updated_at": "2023-11-07T05:31:56Z",
"predictions": {},
"draft": {
"schema_overrides": {
"descriptionsOverride": {},
"reasoningPromptsOverride": {}
},
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}
Get an project by ID
from retab import Retab
client = Retab()
response = client.projects.get("<project_id>")
{
"id": "<string>",
"name": "",
"json_schema": {},
"updated_at": "2023-11-07T05:31:56Z",
"sheets_integration": {
"sheet_id": "<string>",
"spreadsheet_id": "<string>"
},
"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": [
{}
]
},
"playground_extraction": {},
"playground_extraction_metadata": {
"extraction_id": "<string>",
"likelihoods": {},
"field_locations": {},
"agentic_field_locations": {},
"consensus_details": [
{}
]
},
"id": "<string>",
"ocr_file_id": "<string>"
}
],
"iterations": [
{
"id": "<string>",
"parent_id": "<string>",
"inference_settings": {
"model": "gpt-5-mini",
"temperature": 0,
"reasoning_effort": "minimal",
"image_resolution_dpi": 96,
"browser_canvas": "A4",
"n_consensus": 1
},
"schema_overrides": {
"descriptionsOverride": {},
"reasoningPromptsOverride": {}
},
"updated_at": "2023-11-07T05:31:56Z",
"predictions": {},
"draft": {
"schema_overrides": {
"descriptionsOverride": {},
"reasoningPromptsOverride": {}
},
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}
from retab import Retab
client = Retab()
response = client.projects.get("<project_id>")
Successful Response