API referansı İngilizce yayımlanır.
Update an agent
PATCH
/api/agents/{id}Personal API keyAgent API keyConsole session
Update an agent.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
idstringZorunluThe agent's id.
İstek gövdesi
application/json · zorunlu
namestringİsteğe bağlı
at least 1 characterrolestringİsteğe bağlı
one of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"titlestring | nullİsteğe bağlı
iconstring | nullİsteğe bağlı
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İsteğe bağlı
appearance.schemaVersionnumberZorunlu
one of: 1appearance.characterVersionstringZorunlu
one of: "cap-v1"appearance.paletteIdstringZorunlu
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İsteğe bağlı
reportsTostring (uuid) | nullİsteğe bağlı
capabilitiesstring | nullİsteğe bağlı
desiredSkillsarray<string | object>İsteğe bağlı
adapterTypestringİsteğe bağlı
at least 1 characterrunnerstringİsteğe bağlı
one of: "auto", "veyra", "legacy"adapterConfigobjectİsteğe bağlı
instructionsBundleobjectİsteğe bağlı
instructionsBundle.entryFilestringİsteğe bağlı
at least 1 characterinstructionsBundle.filesobject<string, string>Zorunlu
runtimeConfigobjectİsteğe bağlı
runtimeConfig.aiConnectionobjectİsteğe bağlı
runtimeConfig.debugobjectİsteğe bağlı
runtimeConfig.debug.providerTracestringİsteğe bağlı
one of: "raw"defaultEnvironmentIdstring (uuid) | nullİsteğe bağlı
budgetMonthlyCentsintegerİsteğe bağlı
≥ 0metadataobject | nullİsteğe bağlı
storedSessionIdstringİsteğe bağlı
1–256 charactersapplyStoredClaudeLoginbooleanİsteğe bağlı
runtimeSettingsobjectİsteğe bağlı
runtimeSettings.harnessstringZorunlu
at least 1 characterruntimeSettings.modelstringİsteğe bağlı
1–512 charactersruntimeSettings.aiConnectionobjectİsteğe bağlı
runtimeSettings.expectedobjectZorunlu
runtimeSettings.expected.modelstring | nullZorunlu
runtimeSettings.expected.aiConnectionobject | nullZorunlu
replaceAdapterConfigbooleanİsteğe bağlı
expectedConfigurationRevisionstringİsteğe bağlı
pattern: ^[a-f0-9]{64}$statusstringİsteğe bağlı
one of: "paused", "idle", "terminated"Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.