Chapitres · Organisation de la clé API
Organisation de la clé API
Identifier l’organisation rattachée à une clé API.
Cette lecture renvoie l’organisation à laquelle appartient la clé. Le chemin canonique /api/v1/organization et son alias /api/v1/me utilisent le même traitement.
Réponse
| Champ | Description |
|---|---|
organization.id | Identifiant de l’organisation. |
organization.name | Nom de l’organisation. |
organization.slug | Adresse courte utilisée dans les liens, ou null. |
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é.