API referansı İngilizce yayımlanır.

Create an agent

POST/api/companies/{companyId}/agents
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 4 · Geçmiş

Create 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

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

setupIdstring (uuid)İsteğe bağlı
namestringZorunluat least 1 character
rolestringİ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.schemaVersionnumberZorunluone of: 1
appearance.characterVersionstringZorunluone of: "cap-v1"
appearance.paletteIdstringZorunluone 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 character
runnerstringİ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 character
instructionsBundle.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ı≥ 0
permissionsobjectİsteğe bağlı
permissions.canCreateAgentsbooleanİsteğe bağlı
permissions.canCreateSkillsbooleanİsteğe bağlı
permissions.trustPresetstringİsteğe bağlıone of: "standard", "low_trust_review"
permissions.authorizationPolicyobjectİsteğe bağlı
permissions.authorizationPolicy.trustPresetstringİsteğe bağlıone of: "standard", "low_trust_review"
permissions.authorizationPolicy.reviewPresetobjectİsteğe bağlı
permissions.authorizationPolicy.trustBoundaryobjectİsteğe bağlı
permissions.authorizationPolicy.assignmentPolicyobjectİsteğe bağlı
permissions.authorizationPolicy.protectedAgentobjectİsteğe bağlı
permissions.interactionsobjectİsteğe bağlı
permissions.interactions.canAssignTasksToAgentsbooleanİsteğe bağlı
permissions.interactions.canReceiveAssignmentsFromAgentsbooleanİsteğe bağlı
permissions.interactions.canAssignTasksToHumansbooleanİsteğe bağlı
permissions.interactions.canMentionAgentsbooleanİsteğe bağlı
permissions.interactions.canReceiveMentionsFromAgentsbooleanİsteğe bağlı
permissions.interactions.canCommentOnOtherTasksbooleanİsteğe bağlı
permissions.interactions.canReceiveCommentsFromAgentsbooleanİsteğe bağlı
permissions.interactions.canEditOtherTasksbooleanİsteğe bağlı
permissions.interactions.canReceiveTaskEditsFromAgentsbooleanİsteğe bağlı
permissions.interactions.canConfigureOtherAgentsbooleanİsteğe bağlı
permissions.interactions.canReceiveConfigurationChangesFromAgentsbooleanİsteğe bağlı
metadataobject | nullİsteğe bağlı
storedSessionIdstringİsteğe bağlı1–256 characters
applyStoredClaudeLoginbooleanİsteğe bağlı
onboardingFirstAgentbooleanİsteğe bağlı

Yanıtlar

201SuccessCreated; the body holds the new resource.
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.

Agents