Ui Ai Sdk Chat

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/ai-sdk/{agent}: the part of an AI SDK 7 chat request (DefaultChatTransport's body) that threads reads. Other keys, and other fields of messages and parts, are ignored: the browser's history is never read as truth.

id*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}$

messages*array<>

Items1 <= items

trigger*unknown

Value in

"submit-message"
"regenerate-message"

messageId?string

[key: string]?any

Response Body

`text/event-stream`

`application/json`

curl -X POST "https://example.com/v1/ui/ai-sdk/string" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "messages": [      {        "id": "string",        "role": "system",        "parts": [          {            "type": "string"          }        ]      }    ],    "trigger": "submit-message"  }'

"string"