Skip to main content
POST
Run an agent

Path Parameters

agent_id
string
required

Agent id from the dashboard, for example agt_....

Body

application/json

AG-UI run input. Field names are camelCase on the wire.

threadId
string
required
runId
string
required
messages
object[]
required
parentRunId
string | null
tools
object[]

Forwarded for protocol compatibility. Does not add tools to the agent.

context
object[]
state
object

May set max_steps (1–500) and compress_context.

forwardedProps
object
resume
any

Response

AG-UI Server-Sent Events. Event types include RUN_STARTED, TEXT_MESSAGE_CONTENT, TOOL_CALL_START, TOOL_CALL_RESULT, RUN_FINISHED, and RUN_ERROR.

The response is of type string.