Справочник API публикуется на английском языке.
Preview catalog team install
POST
/api/companies/{companyId}/teams/catalog/{catalogId}/previewPersonal API keyAgent API keyConsole session
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.
Авторизация
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.
catalogIdstringОбязательныйThe catalog's id.
Тело запроса
application/json · обязательно
targetManagerAgentIdstring | nullНеобязательный
at least 1 charactertargetManagerSlugstring | nullНеобязательный
at least 1 characterincludeobjectНеобязательный
include.agentsbooleanНеобязательный
include.projectsbooleanНеобязательный
include.issuesbooleanНеобязательный
include.skillsbooleanНеобязательный
agentsstring | array<string>Необязательный
collisionStrategystringНеобязательный
one of: "rename", "skip", "replace"nameOverridesobject<string, string>Необязательный
selectedFilesarray<string>Необязательный
sourcePolicyobjectНеобязательный
sourcePolicy.allowExternalSourcesbooleanНеобязательный
sourcePolicy.allowUnpinnedOptionalSourcesbooleanНеобязательный
sourcePolicy.allowLocalPathSourcesbooleanНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.