Update agent abilities
Turn the agent’s native abilities on or off and set their options: Web Search, Web Fetch, Image Generation, Search Past Conversations, Ask Question, Manage Evaluations, Chat Widgets, and Browser.
What happens to abilities left out of the request?
What happens to abilities left out of the request?
403.Authorizations
Path Parameters
ID of a custom agent.
Body
Native abilities. On PATCH /agents/{agent_id}/abilities send only the ones you want to change; each is a small object so settings travel with the toggle.
Whether the agent may pause to ask the person a question.
Deprecated and ignored: every agent reaches its connectors through search and tool_call. Reads return enabled; a write that sends it is accepted, not applied, and reported in deprecations. Removed in the next release.
Compact visuals in web chats. On by default for new custom agents; enable explicitly on older agents. Represented in tools by {"type": "chat_widget"}.
Include enabled: true when updating browser options and keeping the ability on. Omitting the browser object preserves the ability and its saved options.
Optional. The version you last read; the update is refused with 409 agent_version_conflict if the agent changed since.
Response
The agent's abilities after the change.
"abc123DEFghiJKL"
Native abilities. On PATCH /agents/{agent_id}/abilities send only the ones you want to change; each is a small object so settings travel with the toggle.
5
Present only when the request sent a retired field. Each entry names the field (dotted for nested, e.g. metadata.tool_discovery) and says what replaced it and when it is removed. The write itself succeeds with the field ignored.