AGagentarea
v1
protected
agents

Update Agent

Changed on

Update an agent (by UUID or workspace-scoped slug).

patch/v1/workspaces/{workspace}/agents/{agent_id}

Request

Path parameters

agent_idstring required
workspacestring required

Slug of the workspace the request acts in

Request body

a2ui_enabledboolean nullable
agent_type'stateless' | 'stateful'
capabilitiesstring[] nullable
client_idstring uuid nullable

A Codex or Claude Code client of this workspace whose runner runs the agent's tasks on the CLI's subscription; null runs them on the platform's own loop and model.

descriptionstring nullable
instructionstring nullable
model_idstring nullable
namestring
planningboolean nullable
reasoning_effortstring nullable

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_tokensinteger nullable

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

skill_idsstring[] nullable

Response

Successful Response

a2a_urlstring nullable
a2ui_enabledboolean nullable
agent_typestring
client_idstring uuid nullable
descriptionstring nullable
idstring uuid required
instructionstring nullable
is_catalogboolean
model_idstring nullable
namestring required
planningboolean nullable
reasoning_effortstring nullable
reasoning_max_tokensinteger nullable
registry_item_idstring nullable
skillsobject[] nullable
slugstring required
statusstring required
update_availableboolean

Changes

  • fc6f062f7d70Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 97bdabfb1aaaRevision changes
    • info

      added the new optional request property //////

    • info

      added the optional property ////// to the response with the status