Skip to content

docs(plugin-chatbot): name the authored key as requestBody, not body #6193

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

Merged
yinlianghui-tw merged 1 commit into from
Aug 25, 2026
Merged

docs(plugin-chatbot): name the authored key as requestBody, not body #6193

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
4 changes: 2 additions & 2 deletions content/docs/plugins/plugin-chatbot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ const schema = {
model?: string,
streamingEnabled?: boolean,
headers?: Record<string, string>,
body?: Record<string, unknown>,
requestBody?: Record<string, unknown>,
maxToolRoundtrips?: number, // deprecated - inert, see below
onError?: (error: Error) => void,
}
Expand Down Expand Up @@ -151,7 +151,7 @@ const schema = {
| `model` | string | - | AI model identifier (e.g., `gpt-4o`) |
| `streamingEnabled` | boolean | `true` | Enable SSE streaming for AI responses |
| `headers` | object | - | Additional headers for API requests |
| `body` | object | - | Additional body params for API requests |
| `requestBody` | object | - | Additional body parameters sent with each API request. Authored on the node as `requestBody`; the renderer forwards it to the chat runtime under its own `body` option. Writing `body` on the node instead sets the base schema's children container and never reaches the API |
| `maxToolRoundtrips` | number | - | **Deprecated - has no effect.** Nothing reads this value, so it never capped anything. Cap tool-calling loops on the agent instead (`planning.maxIterations`). Still accepted so existing documents keep parsing; slated for removal in a future major |
| `surface` | `'card' \| 'plain'` | `'card'` | Controls whether the chat renders as a bordered panel or a frameless full-page workspace |
| `processVisibility` | `'hidden' \| 'summary' \| 'debug'` | `'summary'` | Controls how much agent reasoning and tool detail is shown |
Expand Down