La referencia de la API se publica en inglés.

Create an agent

POST/api/companies/{companyId}/agents
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 4 · Historial

Create an agent.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

setupIdstring (uuid)Opcional
namestringObligatorioat least 1 character
rolestringOpcionalone of: "ceo", "cto", "cmo", "cfo", "security", "engineer", "designer", "pm", "qa", "devops", "researcher", "general"
titlestring | nullOpcional
iconstring | nullOpcionalone 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"
appearanceobjectOpcional
appearance.schemaVersionnumberObligatorioone of: 1
appearance.characterVersionstringObligatorioone of: "cap-v1"
appearance.paletteIdstringObligatorioone 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.customAvatarAssetIdstringOpcional
reportsTostring (uuid) | nullOpcional
capabilitiesstring | nullOpcional
desiredSkillsarray<string | object>Opcional
adapterTypestringOpcionalat least 1 character
runnerstringOpcionalone of: "auto", "veyra", "legacy"
adapterConfigobjectOpcional
instructionsBundleobjectOpcional
instructionsBundle.entryFilestringOpcionalat least 1 character
instructionsBundle.filesobject<string, string>Obligatorio
runtimeConfigobjectOpcional
runtimeConfig.aiConnectionobjectOpcional
runtimeConfig.debugobjectOpcional
runtimeConfig.debug.providerTracestringOpcionalone of: "raw"
defaultEnvironmentIdstring (uuid) | nullOpcional
budgetMonthlyCentsintegerOpcional≥ 0
permissionsobjectOpcional
permissions.canCreateAgentsbooleanOpcional
permissions.canCreateSkillsbooleanOpcional
permissions.trustPresetstringOpcionalone of: "standard", "low_trust_review"
permissions.authorizationPolicyobjectOpcional
permissions.authorizationPolicy.trustPresetstringOpcionalone of: "standard", "low_trust_review"
permissions.authorizationPolicy.reviewPresetobjectOpcional
permissions.authorizationPolicy.trustBoundaryobjectOpcional
permissions.authorizationPolicy.assignmentPolicyobjectOpcional
permissions.authorizationPolicy.protectedAgentobjectOpcional
permissions.interactionsobjectOpcional
permissions.interactions.canAssignTasksToAgentsbooleanOpcional
permissions.interactions.canReceiveAssignmentsFromAgentsbooleanOpcional
permissions.interactions.canAssignTasksToHumansbooleanOpcional
permissions.interactions.canMentionAgentsbooleanOpcional
permissions.interactions.canReceiveMentionsFromAgentsbooleanOpcional
permissions.interactions.canCommentOnOtherTasksbooleanOpcional
permissions.interactions.canReceiveCommentsFromAgentsbooleanOpcional
permissions.interactions.canEditOtherTasksbooleanOpcional
permissions.interactions.canReceiveTaskEditsFromAgentsbooleanOpcional
permissions.interactions.canConfigureOtherAgentsbooleanOpcional
permissions.interactions.canReceiveConfigurationChangesFromAgentsbooleanOpcional
metadataobject | nullOpcional
storedSessionIdstringOpcional1–256 characters
applyStoredClaudeLoginbooleanOpcional
onboardingFirstAgentbooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Agents