Créer une API Key

POST /api/open/v1/keys

Paramètres de requête

Le corps de la requête est en JSON avec Content-Type: application/json. Les règles de validation sont les mêmes que pour la création de Key dans la console.

Champ	Type	Requis	Défaut	Description
`name`	string	Oui	—	Nom, jusqu’à 50 caractères (caractères, pas octets) ; ne peut pas être vide
`remain_amount`	number	Non	`0`	Montant disponible dans la devise du site, deux décimales ; s’applique lorsque `unlimited` vaut `false` ; ne doit pas être négatif ni dépasser le maximum
`unlimited`	boolean	Non	`false`	Indique si la Key est illimitée
`expired_time`	integer	Non	`-1`	Date d’expiration, secondes unix ; absent, `0` et `-1` signifient tous sans expiration ; sinon il doit être dans le futur et au plus tard le 9999-12-31
`model_limits_enabled`	boolean	Non	`false`	Indique s’il faut activer la liste blanche de modèles
`model_limits`	string	Non	`""`	Modèles autorisés, séparés par des virgules
`allow_ips`	string	Non	—	IP autorisées, séparées par des retours à la ligne ; absent ou chaîne vide signifie aucune restriction

Exemple de requête

curl -X POST https://www.routeapi.ai/api/open/v1/keys \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "bot",
    "remain_amount": 5.00,
    "unlimited": false,
    "expired_time": -1,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o"
  }'

Exemple de réponse

{
  "success": true,
  "message": "",
  "data": {
    "id": 13,
    "name": "bot",
    "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": 1,
    "created_time": 1729000000,
    "accessed_time": 1729000000,
    "expired_time": -1,
    "remain_amount": 5.00,
    "unlimited": false,
    "used_amount": 0.00,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o",
    "allow_ips": ""
  }
}

Pour la description des champs, voir Objet Key.

Erreurs

HTTP	code	Scénario
400	`invalid_request`	Le corps n’est pas un JSON valide, ou est vide / `null`
400	`invalid_request`	`name` est absent, vide ou dépasse 50 caractères
400	`invalid_request`	`expired_time` n’est pas dans le futur (et ne vaut ni `0` ni `-1`), ou dépasse le 9999-12-31 (par exemple un timestamp en millisecondes)
400	`invalid_request`	Le nombre maximal de Keys par utilisateur est atteint
400	`invalid_request`	`remain_amount` négatif ou supérieur au maximum alors que `unlimited` vaut `false`

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

Remarques

remain_amount est ignoré lorsque unlimited vaut true.
La création d’une Key via l’API de la plateforme est enregistrée dans le journal d’audit.