Справочник API публикуется на английском языке.
Hire an agent
POST
/api/companies/{companyId}/agent-hiresPersonal API keyAgent API keyConsole session
Hire 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. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
namestringОбязательный
at least 1 characterrolestringНеобязательный
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: 1appearance.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 characterrunnerstringНеобязательный
one of: "auto", "veyra", "legacy"adapterConfigobjectНеобязательный
instructionsBundleobjectНеобязательный
instructionsBundle.entryFilestringНеобязательный
at least 1 characterinstructionsBundle.filesobject<string, string>Обязательный
runtimeConfigobjectНеобязательный
runtimeConfig.aiConnectionobjectНеобязательный
runtimeConfig.debugobjectНеобязательный
runtimeConfig.debug.providerTracestringНеобязательный
one of: "raw"defaultEnvironmentIdstring (uuid) | nullНеобязательный
budgetMonthlyCentsintegerНеобязательный
≥ 0permissionsobjectНеобязательный
permissions.canCreateAgentsbooleanНеобязательный
permissions.canCreateSkillsbooleanНеобязательный
permissions.trustPresetstringНеобязательный
one of: "standard", "low_trust_review"permissions.authorizationPolicyobjectНеобязательный
permissions.authorizationPolicy.trustPresetstringНеобязательный
one of: "standard", "low_trust_review"permissions.authorizationPolicy.reviewPresetobjectНеобязательный
permissions.authorizationPolicy.trustBoundaryobjectНеобязательный
permissions.authorizationPolicy.assignmentPolicyobjectНеобязательный
permissions.authorizationPolicy.protectedAgentobjectНеобязательный
permissions.interactionsobjectНеобязательный
permissions.interactions.canAssignTasksToAgentsbooleanНеобязательный
permissions.interactions.canReceiveAssignmentsFromAgentsbooleanНеобязательный
permissions.interactions.canAssignTasksToHumansbooleanНеобязательный
permissions.interactions.canMentionAgentsbooleanНеобязательный
permissions.interactions.canReceiveMentionsFromAgentsbooleanНеобязательный
permissions.interactions.canCommentOnOtherTasksbooleanНеобязательный
permissions.interactions.canReceiveCommentsFromAgentsbooleanНеобязательный
permissions.interactions.canEditOtherTasksbooleanНеобязательный
permissions.interactions.canReceiveTaskEditsFromAgentsbooleanНеобязательный
permissions.interactions.canConfigureOtherAgentsbooleanНеобязательный
permissions.interactions.canReceiveConfigurationChangesFromAgentsbooleanНеобязательный
metadataobject | nullНеобязательный
storedSessionIdstringНеобязательный
1–256 charactersapplyStoredClaudeLoginbooleanНеобязательный
onboardingFirstAgentbooleanНеобязательный
setupAgentIdstring (uuid)Необязательный
sourceIssueIdstring (uuid) | nullНеобязательный
sourceIssueIdsarray<string (uuid)>Необязательный
inheritRuntimeFromstringНеобязательный
one of: "caller"Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.