Install catalog team

POST/api/companies/{companyId}/teams/catalog/{catalogId}/install
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

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.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
catalogIdstringRequiredThe catalog's id.

Request body

application/json · required

targetManagerAgentIdstring | nullOptionalat least 1 character
targetManagerSlugstring | nullOptionalat least 1 character
includeobjectOptional
include.agentsbooleanOptional
include.projectsbooleanOptional
include.issuesbooleanOptional
include.skillsbooleanOptional
agentsstring | array<string>Optional
collisionStrategystringOptionalone of: "rename", "skip", "replace"
nameOverridesobject<string, string>Optional
selectedFilesarray<string>Optional
sourcePolicyobjectOptional
sourcePolicy.allowExternalSourcesbooleanOptional
sourcePolicy.allowUnpinnedOptionalSourcesbooleanOptional
sourcePolicy.allowLocalPathSourcesbooleanOptional
adapterOverridesobject<string, object>Optional
secretValuesobject<string, string>Optional
agentBudgetMonthlyCentsintegerOptional> 0≤ 100000000

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Teams catalog