Skip to main content
PATCH
Change an AI agent (only the fields sent)

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required
agent_id
string
required

Body

application/json

Any subset of the create body. Fields left out keep their current values — unlike PUT, which replaces the whole agent and resets what it omits. memory_dataset: null stops storing replies; active: false retires it. The MCP tool update_ai_agent uses this.

name
string
Required string length: 1 - 120
active
boolean
default:true
model
string

A model from GET /admin/api/ai-models; one off the list is refused. Left out, the stored model is kept, even one saved before the list existed (#196).

system_prompt
string
Maximum string length: 8000
prompt
string
tools
any[]

Not supported; only an empty list is accepted. Any tools stored before #196 (never used) are cleared by an edit.

memory_dataset
string | null
max_tokens
integer
default:1024

Response

Changed.

ok
enum<boolean>
required
Available options:
true