Skip to main content
POST
Asynchronous structured research

Authorizations

Authorization
string
header
required

API key ret_live_… created in Settings → API keys.

Body

application/json
query
string
required
Minimum string length: 1
output_schema
object

JSON Schema of the expected value.

instructions
string
max_steps
integer
default:30
Required range: 1 <= x <= 100
model
enum<string>
default:fast
deprecated

Deprecated: every run uses the same model. smart is accepted and runs as fast.

Available options:
fast,
smart
stream
boolean
default:false

Response

Job started.

ok
boolean
run_id
string
Example:

"go_run_9a8b7c1d2e3f4a5b"

status
enum<string>

Always running when created.

Available options:
running
poll_url
string
created_at
string<date-time>