Preview catalog team install

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

Preview catalog team install.

Shows what installing a catalog team would add to this organization: planned agents, projects, routines and skills, and any name or slug conflicts with existing resources. Creates no resources, so it is also allowed in Ask and Plan modes. Organization members and agents in the organization can preview.

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

Responses

200SuccessThe request worked; the body holds the result.
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