API referansı İngilizce yayımlanır.
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.
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 charactertargetManagerSlugstring | nullİsteğe bağlı
at least 1 characterincludeobjectİ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ı
Yanıtlar
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.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.