La référence de l'API est publiée en anglais.
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.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
catalogIdstringObligatoireThe catalog's id.
Corps de la requête
application/json · obligatoire
targetManagerAgentIdstring | nullFacultatif
at least 1 charactertargetManagerSlugstring | nullFacultatif
at least 1 characterincludeobjectFacultatif
include.agentsbooleanFacultatif
include.projectsbooleanFacultatif
include.issuesbooleanFacultatif
include.skillsbooleanFacultatif
agentsstring | array<string>Facultatif
collisionStrategystringFacultatif
one of: "rename", "skip", "replace"nameOverridesobject<string, string>Facultatif
selectedFilesarray<string>Facultatif
sourcePolicyobjectFacultatif
sourcePolicy.allowExternalSourcesbooleanFacultatif
sourcePolicy.allowUnpinnedOptionalSourcesbooleanFacultatif
sourcePolicy.allowLocalPathSourcesbooleanFacultatif
Réponses
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.
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.