Skip to content

[Agents] Sync Agents SDK docs #31688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
threepointone wants to merge 1 commit into
base: production
Choose a base branch
from
+915 −30
Open

[Agents] Sync Agents SDK docs #31688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions src/content/docs/agents/communication-channels/chat/chat-agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,17 +869,18 @@ function Chat() {

### Options

| Option | Type | Default | Description |
| ----------------------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `agent` | `ReturnType<typeof useAgent>` | Required | Agent connection from `useAgent` |
| `onToolCall` | `({ toolCall, addToolOutput }) => void` | — | Handle client-side tool execution |
| `tools` | `Record<string, AITool>` | — | Advanced: dynamically register client-executed tools from the browser |
| `autoContinueAfterToolResult` | `boolean` | `true` | Auto-continue conversation after client tool results and approvals |
| `resume` | `boolean` | `true` | Enable automatic stream resumption on reconnect |
| `cancelOnClientAbort` | `boolean` | `false` | Cancel the server turn when generic client stream abort or cleanup occurs |
| `body` | `object \| () => object` | — | Custom data sent with every request |
| `prepareSendMessagesRequest` | `(options) => { body?, headers? }` | — | Advanced per-request customization |
| `getInitialMessages` | `(options) => Promise<UIMessage[]>` or `null` | — | Custom initial message loader. Set to `null` to skip the HTTP fetch entirely (useful when providing `messages` directly) |
| Option | Type | Default | Description |
| ----------------------------- | --------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent` | `ReturnType<typeof useAgent>` | Required | Agent connection from `useAgent` |
| `onToolCall` | `({ toolCall, addToolOutput }) => void` | — | Handle client-side tool execution |
| `tools` | `Record<string, AITool>` | — | Advanced: dynamically register client-executed tools from the browser |
| `autoContinueAfterToolResult` | `boolean` | `true` | Auto-continue conversation after client tool results and approvals |
| `resume` | `boolean` | `true` | Enable automatic stream resumption on reconnect |
| `cancelOnClientAbort` | `boolean` | `false` | Cancel the server turn when generic client stream abort or cleanup occurs |
| `body` | `object \| () => object` | — | Custom data sent with every request |
| `prepareSendMessagesRequest` | `(options) => { body?, headers? }` | — | Advanced per-request customization |
| `getInitialMessages` | `(options) => Promise<UIMessage[]>` or `null` | — | Custom initial message loader. Set to `null` to skip the HTTP fetch entirely (useful when providing `messages` directly) |
| `syncMessagesToServer` | `boolean` | `true` | When `true`, `setMessages` pushes the transcript to the server. Set to `false` for hosts with server-authoritative transcript storage so `setMessages` updates the local view only |

### Return values

Expand Down
Loading