Skip to main content
GET
/
v1
/
projects
/
{project_id}
/
iterations
/
{iteration_id}
Get Iteration
curl --request GET \
  --url https://api.retab.com/v1/projects/{project_id}/iterations/{iteration_id}
{
  "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"
  }
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
project_id
string
required
​
iteration_id
string
required

Response

Successful Response

​
inference_settings
object
required
​
id
string
​
parent_id
string | null

The ID of the parent iteration

​
schema_overrides
object

Map of field path -> non-structural schema overrides (description, reasoning_prompt)

​
updated_at
string<date-time>

The last update date of inference settings or schema overrides

​
predictions
object

The predictions of the iteration for all the documents

​
draft
object | null

The draft iteration of the iteration