Skip to main content
POST
/
v1
/
beta
/
deepresearch
/
extract
Extract
curl --request POST \
  --url https://api.retab.com/v1/beta/deepresearch/extract \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "filename": "<string>",
    "url": "<string>"
  },
  "json_schema": {},
  "inference_settings": {
    "model": "gpt-5-mini",
    "temperature": 0,
    "reasoning_effort": "minimal",
    "image_resolution_dpi": 192
  },
  "num_agentic_steps": 7,
  "max_tool_calls": 3
}
'
{
  "success": false,
  "message": "",
  "data": {},
  "error": "<string>"
}

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
access_token
string | null

Body

application/json
​
document
MIMEData · object
required
​
json_schema
Json Schema · object
required

JSON schema defining the structure of data to extract

​
inference_settings
DeepResearchInferenceSettings · object
required
​
num_agentic_steps
integer
default:7

Number of agentic steps (only used with use_agentic_pipeline)

​
max_tool_calls
integer
default:3

Maximum number of tool calls per step

Required range: 1 <= x <= 10

Response

Successful Response

​
success
boolean
default:false
​
message
string
default:""
​
data
Data · object
​
error
string | null