Lister les API Keys

GET /api/open/v1/keys

Paramètres de requête

Paramètre	Emplacement	Type	Requis	Défaut	Description
p	query	integer	Non	1	Numéro de page, de 1 à 1000000
page_size	query	integer	Non	10	Éléments par page, de 1 à 1000
name	query	string	Non	—	Filtrer par nom de Key exact ; répétez le paramètre pour plusieurs valeurs (?name=a&name=b). Les virgules ne sont pas prises en charge car les noms peuvent en contenir

Chaque paramètre multi-valeurs accepte au maximum 50 valeurs ; au-delà, la réponse est 400 invalid_request. Lorsque name est défini, total reflète le résultat filtré. Un p / page_size fourni explicitement et invalide retourne 400 ; voir Pagination.

Exemple de requête

curl "https://www.routeapi.ai/api/open/v1/keys?p=1&page_size=20&name=bot" \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

Exemple de réponse

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": 12,
        "name": "bot",
        "key": "sk-abcd**********wxyz",
        "status": 1,
        "created_time": 1729000000,
        "accessed_time": 1729000000,
        "expired_time": -1,
        "remain_amount": 10.00,
        "unlimited": false,
        "used_amount": 0.00,
        "model_limits_enabled": true,
        "model_limits": "gpt-4o,gpt-4o-mini",
        "allow_ips": ""
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}

Champs de réponse

Champ	Type	Description
items	array	Objets Key, triés par ID décroissant (les plus récents en premier)
total	integer	Nombre total de Keys correspondant aux filtres
page	integer	Numéro de page courant
page_size	integer	Nombre effectif d’éléments par page

Objet Key

Tous les endpoints de l’API de la plateforme qui retournent une Key utilisent la même structure :

Champ	Type	Description
id	integer	ID de la Key, utilisé comme :id dans les autres endpoints
name	string	Nom
key	string	Valeur de la Key avec le préfixe sk- ; masquée partout sauf dans l’endpoint de création et Révéler une API Key
status	integer	1 activée, 2 désactivée (arrêt manuel ; peut être réactivée), 3 expirée, 4 épuisée ; activez ou désactivez via l’endpoint de mise à jour (1 / 2 uniquement)
created_time	integer	Date de création, secondes unix
accessed_time	integer	Date de dernière utilisation, secondes unix
expired_time	integer	Date d’expiration, secondes unix ; -1 signifie sans expiration
remain_amount	number	Montant disponible restant, deux décimales ; sans objet lorsque unlimited vaut true
unlimited	boolean	Indique si la Key est illimitée
used_amount	number	Montant utilisé, deux décimales
model_limits_enabled	boolean	Indique si la liste blanche de modèles est activée
model_limits	string	Modèles autorisés, séparés par des virgules
allow_ips	string	IP autorisées, séparées par des retours à la ligne ; une chaîne vide signifie aucune restriction

Remarques

• Les montants utilisent la devise d’affichage du site, voir Obtenir le solde.
• Pour les codes d’erreur communs, voir Erreurs de l’API de la plateforme.