Update an agent
PATCH
/api/agents/{id}Personal API keyAgent API keyConsole session
Update an agent.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
idstringRequiredThe agent's id.
Request body
application/json · required
namestringOptional
at least 1 characterrolestringOptional
one of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"titlestring | nullOptional
iconstring | nullOptional
one of: "bot", "cpu", "brain", "zap", "rocket", "code", "terminal", "shield", "eye", "search", "wrench", "hammer", "lightbulb", "sparkles", "star", "heart", "flame", "bug", "cog", "database", "globe", "lock", "mail", "message-square", "file-code", "git-branch", "package", "puzzle", "target", "wand", "atom", "circuit-board", "radar", "swords", "telescope", "microscope", "crown", "gem", "hexagon", "pentagon", "fingerprint"appearanceobjectOptional
appearance.schemaVersionnumberRequired
one of: 1appearance.characterVersionstringRequired
one of: "cap-v1"appearance.paletteIdstringRequired
one of: "bubblegum-sky", "pink-lemonade", "orchid-peach", "coral-mint", "lime-lagoon", "arctic-blue", "solar-flare", "violet-ember", "deep-tide", "coral-current", "golden-hour", "tangerine-cobalt", "electric-grove", "flamingo-jade", "cherry-pop", "turquoise-cherry", "ultraviolet-tide"appearance.customAvatarAssetIdstringOptional
reportsTostring (uuid) | nullOptional
capabilitiesstring | nullOptional
desiredSkillsarray<string | object>Optional
adapterTypestringOptional
at least 1 characterrunnerstringOptional
one of: "auto", "veyra", "legacy"adapterConfigobjectOptional
instructionsBundleobjectOptional
instructionsBundle.entryFilestringOptional
at least 1 characterinstructionsBundle.filesobject<string, string>Required
runtimeConfigobjectOptional
runtimeConfig.aiConnectionobjectOptional
runtimeConfig.debugobjectOptional
runtimeConfig.debug.providerTracestringOptional
one of: "raw"defaultEnvironmentIdstring (uuid) | nullOptional
budgetMonthlyCentsintegerOptional
≥ 0metadataobject | nullOptional
storedSessionIdstringOptional
1–256 charactersapplyStoredClaudeLoginbooleanOptional
runtimeSettingsobjectOptional
runtimeSettings.harnessstringRequired
at least 1 characterruntimeSettings.modelstringOptional
1–512 charactersruntimeSettings.aiConnectionobjectOptional
runtimeSettings.expectedobjectRequired
runtimeSettings.expected.modelstring | nullRequired
runtimeSettings.expected.aiConnectionobject | nullRequired
replaceAdapterConfigbooleanOptional
expectedConfigurationRevisionstringOptional
pattern: ^[a-f0-9]{64}$statusstringOptional
one of: "paused", "idle", "terminated"Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.