v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01165164.7 KB

Agents

Create agent run

Execute an agent run. Set stream to true to receive server-sent events; otherwise the response contains the final agent messages.

post/api/agents/{agent_id}/runs

agent_idstring required

ID of the agent to run.

inputobject

Input fields for an input-form triggered agent.

metadataobject

Metadata to pass to the agent.

streamboolean

Whether to stream the run response as server-sent events.

{
  "messages": [
    {
      "role": "USER"
    }
  ]
}

Successful response.

request_idstring required

Platform-generated request ID for support correlation.

{
  "run": {
    "messages": [
      {
        "role": "USER"
      }
    ]
  },
  "messages": [
    {
      "role": "USER"
    }
  ]
}