Sign in
Agents

Create an agent run and wait for the response

Executes an agent run and returns the final response. Note: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the input object.

post/rest/api/v1/agents/runs/wait

Request body

agent_idstring required

The ID of the agent to run.

inputobject

The input to the agent. Required when the agent uses an input form trigger.

metadataobject

The metadata to pass to the agent.

Example request

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

Response

Success

Example response

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

Changes

Changed in 18 of the 92 revisions of this API.117