Skip to main content
POST
Run agent (synchronous)

Body

application/json

Request model for agent run endpoint.

query
string
required

The query/prompt for the agent

session_id
string | null

Optional session ID for conversation continuity

Response

Successful Response

Response model for synchronous agent run.

agent_name
string
required

Name of the agent

session_id
string
required

Session ID for this conversation

approvals
Approvals · object[] | null

Approvals a paused run is waiting for

budget_request
Budget Request · object | null

The budget a waiting run ran out of, and what it needs

guardrail_result
Guardrail Result · object | null
metric
Metric · object | null

Optional metrics for this run

response
string | null

Agent's response (none while the run awaits approval)

run_id
string | null

Runtime run ID for this run

status
string
default:success

Runtime outcome: success, error, cancelled, awaiting_approval, or awaiting_budget

termination_reason
string | null

Why execution terminated

trace_id
string | null

Telemetry trace ID for this run