Update an agent

PATCH/api/agents/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 4 · History

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

namestringOptionalat least 1 character
rolestringOptionalone of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"
titlestring | nullOptional
iconstring | nullOptionalone 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.schemaVersionnumberRequiredone of: 1
appearance.characterVersionstringRequiredone of: "cap-v1"
appearance.paletteIdstringRequiredone 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
adapterTypestringOptionalat least 1 character
runnerstringOptionalone of: "auto", "veyra", "legacy"
adapterConfigobjectOptional
instructionsBundleobjectOptional
instructionsBundle.entryFilestringOptionalat least 1 character
instructionsBundle.filesobject<string, string>Required
runtimeConfigobjectOptional
runtimeConfig.aiConnectionobjectOptional
runtimeConfig.debugobjectOptional
runtimeConfig.debug.providerTracestringOptionalone of: "raw"
defaultEnvironmentIdstring (uuid) | nullOptional
budgetMonthlyCentsintegerOptional≥ 0
metadataobject | nullOptional
storedSessionIdstringOptional1–256 characters
applyStoredClaudeLoginbooleanOptional
runtimeSettingsobjectOptional
runtimeSettings.harnessstringRequiredat least 1 character
runtimeSettings.modelstringOptional1–512 characters
runtimeSettings.aiConnectionobjectOptional
runtimeSettings.expectedobjectRequired
runtimeSettings.expected.modelstring | nullRequired
runtimeSettings.expected.aiConnectionobject | nullRequired
replaceAdapterConfigbooleanOptional
expectedConfigurationRevisionstringOptionalpattern: ^[a-f0-9]{64}$
statusstringOptionalone 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.

Agents