Browse documentation
Agents
Update an agent
Updates core agent fields such as name, description, instructions, and active/inactive availability. Requires agents:write.
Updating configuration is separate from runtime execution. For current product behavior, isActive is the public callability switch: inactive agents do not appear as models, while active agents can be called once a ready deployment and billing prerequisites are available. Archived agents return 404 and cannot be reactivated.
PATCH
/agents/{agentId}Authorization
AuthorizationBearer <token>Path parameters
agentIdstringrequired- format
"uuid"
Bodyrequired
application/json
object
- minProperties
1
Additional properties are not allowed.
namestring- minLength
1- maxLength
100
descriptionstring | null- maxLength
500
iconstring | null- maxLength
10
commandContentstringisActivebooleanPublic active/inactive switch.
Response
Updated agent.
object
idstringrequired- format
"uuid"
public_idstringrequired- pattern
"^agt_[A-Za-z0-9]+$"
objectstringrequired- const
"agent"
namestringrequiredslugstringrequireddescriptionstring | nulliconstring | nullcommand_contentstringis_activebooleanrequiredPublic active/inactive switch. Active agents can appear in the model list.
created_atintegerrequiredupdated_atintegerrequired