Aller au contenu

Révéler une API Key

GET /api/open/v1/keys/:id/key

Retourne le même objet Key que Obtenir une API Key, sauf que key contient la valeur sk-... complète au lieu de la forme masquée. Utilisez cet endpoint lorsqu’une intégration tierce doit enregistrer ou faire tourner une Key sans demander à l’utilisateur de copier la valeur depuis la console.

ParamètreEmplacementTypeRequisDescription
idpathintegerOuiID de la Key, entier positif
Fenêtre de terminal
curl https://www.routeapi.ai/api/open/v1/keys/12/key \
-H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"
{
"success": true,
"message": "",
"data": {
"id": 12,
"name": "bot",
"key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"status": 1,
"created_time": 1729000000,
"accessed_time": 1729000000,
"expired_time": -1,
"remain_amount": 10.00,
"unlimited": false,
"used_amount": 0.00,
"model_limits_enabled": false,
"model_limits": "",
"allow_ips": ""
}
}

La réponse porte l’en-tête Cache-Control: no-store, afin que ni les navigateurs ni les proxys ne mettent en cache la Key en clair. Pour la description des champs, voir Objet Key.

HTTPcodeScénario
400invalid_requestid n’est pas un entier positif
403insufficient_scopeLa clé de gestion n’a pas la permission requise par cet endpoint
404not_foundLa Key n’existe pas ou ne vous appartient pas
429rate_limitedLimite de requêtes par clé de gestion dépassée
429—Limite de requêtes par IP client dépassée (100 requêtes/20 minutes par défaut pour les endpoints sensibles) ; le corps de la réponse peut être vide

Pour les autres codes d’erreur communs, voir Erreurs de l’API de la plateforme.

  • Chaque appel réussi écrit un événement d’audit (open_api.key.reveal) qui enregistre l’ID et le nom de la Key ainsi que la clé de gestion utilisée. Les Keys en clair ne sont jamais écrites dans l’audit ni dans les logs.
  • Cet endpoint est soumis à une limitation de débit plus stricte que les endpoints de lecture ordinaires, car il renvoie des secrets.
  • La Key complète est aussi renvoyée une fois par Créer une API Key. Privilégiez son enregistrement au moment de la création et n’appelez cet endpoint que si la valeur stockée est perdue ou doit être renouvelée.
  • Obtenir une API Key et Lister les API Keys continuent de renvoyer la valeur masquée.