Sign in

v1

latestOpenAPI 3.0.32026-07-26231418.5 KB
Agents

Update an agent

patch/api/agents/{agent_id}

Path parameters

agent_idstring required

Request body

namestring required
owner_idstring required
runtimestring

Built-in runtime ID or registered runtime harness alias. Stored in agent config.

modelstring
systemstring
descriptionstring
promptstring

Fallback system prompt when system is omitted.

configobject

Example request

{
  "name": "my-agent",
  "owner_id": "local-user",
  "runtime": "cursor",
  "model": "claude-opus-4-5",
  "system": "You are a helpful assistant."
}

Response

Updated agent

idstring
namestring
modelstring
systemstring
toolsobject
configobject

Runtime-specific config. For runtime-backed agents this usually includes runtime.

owner_idstring nullable
statusstring
descriptionstring nullable
harnessstring
created_atinteger

Example response

{
  "name": "my-agent",
  "model": "claude-opus-4-5",
  "status": "paused",
  "harness": "claude-code"
}