Chapitres · Exécuter un outil de l’organisation
Exécuter un outil de l’organisation
Utiliser les outils disponibles pour une connexion autorisée.
Remplacez :name par le nom exact de l’outil. Le corps JSON doit respecter son schéma d’entrée. Une exécution réussie renvoie le résultat dans data et une référence d’assistance dans correlation.
Découvrir les outils
GET /api/v1/tools renvoie les outils disponibles et leurs schémas d’entrée. GET /api/v1/tools/:name renvoie le schéma d’un seul outil. Ces lectures exigent la même authentification que l’exécution.
Les outils actuels permettent de lire l’organisation (get_organization), ses membres (list_members, get_member) et son abonnement (get_subscription). Vérifiez le schéma renvoyé avant chaque intégration. Une connexion n’accorde pas de droits sur une autre organisation.
Corps de la requête
Pour get_member, transmettez memberId, issu de la liste des membres. Un JSON invalide ou des paramètres incompatibles entraînent un refus. Un corps dépassant la limite de 256 Ko est refusé avec le statut 413.
Authentification
Créez une clé dans les paramètres de connexion de votre organisation, si votre rôle l’autorise. Transmettez-la dans l’en-tête x-api-key. Une clé est rattachée à une seule organisation : aucun identifiant d’organisation n’est à ajouter à la requête. Gardez la clé côté serveur et remplacez le domaine d’exemple par celui de votre instance CoolAI.
Erreurs et reprise
| Statut | Signification |
|---|---|
400 | Paramètres invalides ; corrigez la requête. |
401 | Authentification absente, invalide ou expirée. |
403 | Droits insuffisants pour cette opération. |
404 | Ressource introuvable dans le périmètre autorisé. |
500 | Échec du serveur ; réessayez ultérieurement. |
Le corps d’une erreur contient message et correlation. Conservez la référence correlation ou l’en-tête x-correlation-id pour une demande d’assistance ; ne transmettez jamais votre clé.