Skip to main content
PATCH
Update Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string
required

Body

application/json

Patch payload for an agent. All fields optional — unset = unchanged.

a2ui_enabled
boolean | null
agent_type
enum<string> | null
Available options:
stateless,
stateful
capabilities
string[] | null
description
string | null
Maximum string length: 1000
events_config
EventsConfig · object | null

Per-agent event subscriptions.

instruction
string | null
Maximum string length: 20000
model_id
string | null
name
string | null
Required string length: 1 - 255
planning
boolean | null
skill_ids
string<uuid>[] | null
tools
(CodeToolConfig · object | McpToolConfig · object | AgentToolConfig · object | OpenApiToolConfig · object)[] | null

Response

Successful Response

id
string<uuid>
required
name
string
required
slug
string
required
status
string
required
a2ui_enabled
boolean | null
agent_type
string
default:stateless
description
string | null
events_config
Events Config · object | null
instruction
string | null
is_catalog
boolean
default:false
model_id
string | null
planning
boolean | null
registry_item_id
string | null
skills
Skills · object[] | null
tools
(CodeToolConfig · object | McpToolConfig · object | AgentToolConfig · object | OpenApiToolConfig · object)[] | null
update_available
boolean
default:false