aethexDocs
Tableau de bord

Référence API

API Clés API

Gérez les clés API utilisées par votre application pour appeler Aethex.Qui peut faire quoi. Toute clé peut lister les clés de votre locataire via GET /api-keys et se faire tourner elle-même via POST /api-keys/{key_id}/rotate ; la nouvelle clé conserve l'expiration de l'ancienne. Faire tourner toute autre clé relève de la gestion des clés et exige le scope api_keys:write, qu'une clé que vous créez vous-même ne porte jamais : faites tourner, créez et révoquez vos autres clés depuis le portail développeur (Tableau de bord → Clés API), qui appelle les routes authentifiées par session à /api/v1/dashboard/api-keys.Clés émises par la plateforme Aethex. Sur un espace de travail géré par la plateforme Aethex, c'est sa page Paramètres → Clés API qui émet les clés et les fait tourner : une clé sans api_keys:write n'y voit qu'elle-même dans GET /api-keys et ne fait tourner aucune clé, elle-même comprise.Authentification. Envoyez votre clé API existante via X-API-Key: ae_live_… (ou Authorization: Bearer ae_live_…). La rotation renvoie la nouvelle clé une seule fois — stockez-la avant que la réponse ne soit hors de portée.

URL de base
https://api.aethexai.com/api/v1
Endpoints
2
GET/api-keys

Renvoie les clés API de votre locataire. La réponse est un tableau JSON brut (non paginé).

Lister les clés API

Renvoie les clés API actives et révoquées du locataire, des plus récentes aux plus anciennes (la clé interne du portail développeur n'est jamais listée). Sur un espace de travail géré par la plateforme Aethex, une clé sans api_keys:write reçoit à la place un tableau d'un seul élément : cette clé elle-même, avec ses scopes, ses limites de débit, son expiration et son usage. La réponse est un tableau JSON brut — pas d'enveloppe, pas de pagination — prévoyez donc la liste entière à chaque appel.Le champ key est toujours null ici ; la valeur en clair n'est renvoyée qu'à la création ou à la rotation. key_prefix (les 12 premiers caractères de la clé originale, p. ex. ae_live_ebc5) permet de corréler une ligne avec une clé stockée dans votre gestionnaire de secrets.

Erreurs

1
401Non autorisé

Clé API manquante ou invalide.

Envoyez X-API-Key: '<'api_key'>' ou Authorization: Bearer '<'api_key'>'.

POST/api-keys/:key_id/rotate

Émet un nouveau secret pour une clé active, en conservant son nom, ses scopes et ses limites. Une clé peut se faire tourner elle-même ; l'ancien secret reste actif pendant 24 h par défaut.

Faire tourner une clé API

Émet un nouveau secret pour une clé active, en conservant son nom, ses limites de débit et ses scopes (tout scope réservé aux opérateurs est retiré). La clé en clair est renvoyée dans key une seule fois — stockez-la immédiatement.L'ancien secret reste actif pendant une période de grâce de 24 h, ou jusqu'à sa propre expiration si elle arrive plus tôt (old_key_expires_at indique l'heure) ; pendant cette fenêtre les deux secrets authentifient pour permettre un déploiement sans interruption. Passez ?revoke_immediately=true pour révoquer immédiatement l'ancien secret (en cas de compromission suspectée) — old_key_expires_at vaut alors null.Qui peut faire tourner une clé. Une clé peut se faire tourner elle-même, et la nouvelle clé expire quand l'ancienne aurait expiré : à la propre expiration de l'ancienne clé, ou à la fin de la période de grâce qu'une rotation antérieure lui a laissée. Une clé sans expiration donne une nouvelle clé sans expiration. Faire tourner toute autre clé exige le scope api_keys:write : la clé appelante ne peut faire tourner qu'une clé dont elle détient elle-même les limites de débit et les scopes (les scopes réservés aux opérateurs sont retirés de la nouvelle clé, pas comparés), et ne peut faire tourner aucune clé qui détient api_keys:write, elle-même comprise. Sur un espace de travail géré par la plateforme Aethex, aucune clé ne se fait tourner elle-même : faites tourner les clés depuis la page Paramètres → Clés API de la plateforme. Une clé révoquée ou expirée ne peut être renouvelée par personne : créez une nouvelle clé.

Chemin & Requête

2
  • key_idstring (uuid)requis

    ID de la clé API à faire tourner. Utilisez le champ id de GET /api-keys, pas key_prefix.

  • revoke_immediatelybooleanoptionnel

    false (par défaut) : l'ancienne clé reste active 24 h (jamais au-delà de sa propre expiration) ; l'expiration est renvoyée dans old_key_expires_at. true : révoque l'ancienne clé immédiatement.

Erreurs

4
401Non autorisé

Clé API manquante ou invalide.

Envoyez X-API-Key: '<'api_key'>' ou Authorization: Bearer '<'api_key'>'.

403Rotation non autorisée

La clé appelante ne détient pas api_keys:write (Missing scope) et fait tourner une autre clé, ou n'importe quelle clé d'un espace de travail géré par la plateforme Aethex ; ou la clé à faire tourner a des limites de débit, ou des scopes autres que ceux réservés aux opérateurs, que la clé appelante ne détient pas.

Faites tourner une clé avec cette clé elle-même, ou depuis le portail développeur (Tableau de bord → Clés API). Sur un espace de travail géré par la plateforme Aethex, utilisez la page Paramètres → Clés API de la plateforme.

404Clé introuvable

Aucune clé API avec le key_id fourni n'existe sur votre locataire.

Vérifiez l'id avec GET /api-keys.

409Rotation impossible

La clé a été révoquée ou a expiré, ou elle détient elle-même api_keys:write. Ou bien une clé détenant api_keys:write fait tourner une autre clé avec une période de grâce alors que l'espace de travail compte déjà 25 clés actives.

Créez une nouvelle clé à la place d'une clé révoquée ou expirée. Une clé qui détient api_keys:write ne peut pas être renouvelée par cette route. À la limite de 25 clés, révoquez d'abord une clé ou passez ?revoke_immediately=true.