Справочник API публикуется на английском языке.

Update an agent

PATCH/api/agents/{id}
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 4 · История

Update an agent.

Авторизация

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. Как работают ключи.

Параметры пути

idstringОбязательныйThe agent's id.

Тело запроса

application/json · обязательно

namestringНеобязательныйat least 1 character
rolestringНеобязательныйone of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"
titlestring | nullНеобязательный
iconstring | nullНеобязательный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"
appearanceobjectНеобязательный
appearance.schemaVersionnumberОбязательныйone of: 1
appearance.characterVersionstringОбязательныйone of: "cap-v1"
appearance.paletteIdstringОбязательный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.customAvatarAssetIdstringНеобязательный
reportsTostring (uuid) | nullНеобязательный
capabilitiesstring | nullНеобязательный
desiredSkillsarray<string | object>Необязательный
adapterTypestringНеобязательныйat least 1 character
runnerstringНеобязательныйone of: "auto", "veyra", "legacy"
adapterConfigobjectНеобязательный
instructionsBundleobjectНеобязательный
instructionsBundle.entryFilestringНеобязательныйat least 1 character
instructionsBundle.filesobject<string, string>Обязательный
runtimeConfigobjectНеобязательный
runtimeConfig.aiConnectionobjectНеобязательный
runtimeConfig.debugobjectНеобязательный
runtimeConfig.debug.providerTracestringНеобязательныйone of: "raw"
defaultEnvironmentIdstring (uuid) | nullНеобязательный
budgetMonthlyCentsintegerНеобязательный≥ 0
metadataobject | nullНеобязательный
storedSessionIdstringНеобязательный1–256 characters
applyStoredClaudeLoginbooleanНеобязательный
runtimeSettingsobjectНеобязательный
runtimeSettings.harnessstringОбязательныйat least 1 character
runtimeSettings.modelstringНеобязательный1–512 characters
runtimeSettings.aiConnectionobjectНеобязательный
runtimeSettings.expectedobjectОбязательный
runtimeSettings.expected.modelstring | nullОбязательный
runtimeSettings.expected.aiConnectionobject | nullОбязательный
replaceAdapterConfigbooleanНеобязательный
expectedConfigurationRevisionstringНеобязательныйpattern: ^[a-f0-9]{64}$
statusstringНеобязательныйone of: "paused", "idle", "terminated"

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Agents