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
workspace
string
required

Slug of the workspace the request acts in

Maximum string length: 120
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

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

a2ui_enabled
boolean | null
agent_type
enum<string>
Available options:
stateless,
stateful
answer_check
AnswerCheckPolicy · object | null

Check an agent's final answer and have the model rewrite it once if it leaks.

Leaks: CJK characters, tool names and snake_case codes, stack traces, raw JSON, and (for language: ru) lowercase English words in a Russian answer.

capabilities
string[] | null
description
string | null
Maximum string length: 1000
instruction
string | null
Maximum string length: 20000
model_id
string | null
name
string
Required string length: 1 - 255
planning
boolean | null
reasoning_effort
string | null

A reasoning level the model takes, e.g. low or high; the catalog lists each model's levels. Unset keeps the model's default. Not together with reasoning_max_tokens.

reasoning_max_tokens
integer | null

A token budget for the model's reasoning, a positive integer. Unset keeps the model's default. Not together with reasoning_effort.

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
a2a_url
string | null
a2ui_enabled
boolean | null
agent_type
string
default:stateless
answer_check
AnswerCheckPolicy · object | null

Check an agent's final answer and have the model rewrite it once if it leaks.

Leaks: CJK characters, tool names and snake_case codes, stack traces, raw JSON, and (for language: ru) lowercase English words in a Russian answer.

description
string | null
instruction
string | null
is_catalog
boolean
default:false
model_id
string | null
planning
boolean | null
reasoning_effort
string | null
reasoning_max_tokens
integer | 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