Skip to main content
POST
/
agui
Run Agent
curl --request POST \
  --url https://api.example.com/agui \
  --header 'Content-Type: application/json' \
  --data '
{
  "threadId": "<string>",
  "runId": "<string>",
  "state": "<unknown>",
  "messages": [
    {
      "id": "<string>",
      "content": "<string>",
      "role": "developer",
      "name": "<string>",
      "encryptedValue": "<string>"
    }
  ],
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "parameters": "<unknown>"
    }
  ],
  "context": [
    {
      "description": "<string>",
      "value": "<string>"
    }
  ],
  "forwardedProps": "<unknown>",
  "parentRunId": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Input for running an agent.

​
threadId
string
required
​
runId
string
required
​
state
any
required
​
messages
(DeveloperMessage · object | SystemMessage · object | AssistantMessage · object | UserMessage · object | ToolMessage · object | ActivityMessage · object | ReasoningMessage · object)[]
required

A developer message.

​
tools
Tool · object[]
required
​
context
Context · object[]
required
​
forwardedProps
any
required
​
parentRunId
string | null

Response

Successful Response