Ui Ag Ui Run

Authorization

host

AuthorizationBearer <token>

Checked by host({authenticate}), which maps the request to a Principal or rejects it.

In: header

Path Parameters

agent*string

A key of host({agents}).

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

POST /v1/ui/ag-ui/{agent}: the part of an AG-UI 1.0 RunAgentInput that threads reads. state, context and forwardedProps are ignored; a non-empty tools is refused.

threadId*ChatKey

A browser's conversation id on the UI routes (AI SDK useChat({id}), AG-UI threadId). With the signed-in principal and the agent it names one thread (spec/schema/ui/README.md, "Chat key"). Never recorded.

Match^[A-Za-z0-9_.-]{1,128}$

runId*string

messages*array<>

tools?array<>

resume?array<>

[key: string]?any

Response Body

`text/event-stream`

`application/json`

curl -X POST "https://example.com/v1/ui/ag-ui/string" \  -H "Content-Type: application/json" \  -d '{    "threadId": "string",    "runId": "string",    "messages": [      {        "id": "string",        "role": "string"      }    ]  }'

"string"