API referansı İngilizce yayımlanır.

Install catalog team

POST/api/companies/{companyId}/teams/catalog/{catalogId}/install
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Install catalog team.

Installs a catalog team into this organization. Requires a member with permission to create agents, or an agent with permission to create agents; without it, a member can run veyra teams install --organization-id . Imports team resources; HTTP success does not prove every required skill is ready. Read warnings for post-import failures and skillPreparations for required sources; a preparation plan is not proof of installation. Report unresolved requirements as partial completion and preserve existing resources. Use the actual returned portabilityImport agents and projects for organization-scoped resource links. Before repeating an uncertain install, inspect installed teams and saved resource identities rather than creating another copy. resourceLinks provides canonical organization-scoped hrefs for actual saved agents, projects and routines, including reused resources; share these links with the installation outcome.

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.
catalogIdstringZorunluThe catalog's id.

İstek gövdesi

application/json · zorunlu

targetManagerAgentIdstring | nullİsteğe bağlıat least 1 character
targetManagerSlugstring | nullİsteğe bağlıat least 1 character
includeobjectİsteğe bağlı
include.agentsbooleanİsteğe bağlı
include.projectsbooleanİsteğe bağlı
include.issuesbooleanİsteğe bağlı
include.skillsbooleanİsteğe bağlı
agentsstring | array<string>İsteğe bağlı
collisionStrategystringİsteğe bağlıone of: "rename", "skip", "replace"
nameOverridesobject<string, string>İsteğe bağlı
selectedFilesarray<string>İsteğe bağlı
sourcePolicyobjectİsteğe bağlı
sourcePolicy.allowExternalSourcesbooleanİsteğe bağlı
sourcePolicy.allowUnpinnedOptionalSourcesbooleanİsteğe bağlı
sourcePolicy.allowLocalPathSourcesbooleanİsteğe bağlı
adapterOverridesobject<string, object>İsteğe bağlı
secretValuesobject<string, string>İsteğe bağlı
agentBudgetMonthlyCentsintegerİsteğe bağlı> 0≤ 100000000

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.

Teams catalog