UI Control
Drive the app UI from the agent.
1 action. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.
ui.refresh
POST
Trigger a refresh of the client UI so the user sees the latest data. Call this after making changes if you want to ensure the user sees the updated state immediately. This is usually automatic after each tool call, but call it explicitly when you have made multiple sequential changes and want to force a single consolidated refresh at the end.
When the agent calls it: Call this at the end of a batch of mutations so the user sees everything update at once. You do NOT need to call this after every single tool call — the UI already auto-refreshes after each tool. Use this only when you want to signal an explicit "done, refresh now" at the end of a multi-step flow.
- AI tool:
ui_refresh - API:
POST /api/invoke/ui.refresh
Input
| Field | Type | Required | Description |
|---|---|---|---|
reason |
string | — |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"reason": {
"type": "string"
}
}
}