La référence de l'API est publiée en anglais.
Update an agent
PATCH
/api/agents/{id}Personal API keyAgent API keyConsole session
Update an agent.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
idstringObligatoireThe agent's id.
Corps de la requête
application/json · obligatoire
namestringFacultatif
at least 1 characterrolestringFacultatif
one of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"titlestring | nullFacultatif
iconstring | nullFacultatif
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"appearanceobjectFacultatif
appearance.schemaVersionnumberObligatoire
one of: 1appearance.characterVersionstringObligatoire
one of: "cap-v1"appearance.paletteIdstringObligatoire
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.customAvatarAssetIdstringFacultatif
reportsTostring (uuid) | nullFacultatif
capabilitiesstring | nullFacultatif
desiredSkillsarray<string | object>Facultatif
adapterTypestringFacultatif
at least 1 characterrunnerstringFacultatif
one of: "auto", "veyra", "legacy"adapterConfigobjectFacultatif
instructionsBundleobjectFacultatif
instructionsBundle.entryFilestringFacultatif
at least 1 characterinstructionsBundle.filesobject<string, string>Obligatoire
runtimeConfigobjectFacultatif
runtimeConfig.aiConnectionobjectFacultatif
runtimeConfig.debugobjectFacultatif
runtimeConfig.debug.providerTracestringFacultatif
one of: "raw"defaultEnvironmentIdstring (uuid) | nullFacultatif
budgetMonthlyCentsintegerFacultatif
≥ 0metadataobject | nullFacultatif
storedSessionIdstringFacultatif
1–256 charactersapplyStoredClaudeLoginbooleanFacultatif
runtimeSettingsobjectFacultatif
runtimeSettings.harnessstringObligatoire
at least 1 characterruntimeSettings.modelstringFacultatif
1–512 charactersruntimeSettings.aiConnectionobjectFacultatif
runtimeSettings.expectedobjectObligatoire
runtimeSettings.expected.modelstring | nullObligatoire
runtimeSettings.expected.aiConnectionobject | nullObligatoire
replaceAdapterConfigbooleanFacultatif
expectedConfigurationRevisionstringFacultatif
pattern: ^[a-f0-9]{64}$statusstringFacultatif
one of: "paused", "idle", "terminated"Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.