Mettre à jour une clé API - CometAPI Documentation

PUT

api

token

curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "group": "",
    "cross_group_retry": false
  }'

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Utilisez ce endpoint pour mettre à jour le nom, le statut, le quota, l’expiration, les restrictions de modèle, la liste d’autorisation IP et les paramètres de groupe d’une clé API.

Générez un personal access token dans Console → Personal Settings, puis envoyez-le comme valeur brute de l’en-tête Authorization. Ne le préfixez pas avec Bearer.

Ce endpoint utilise PUT /api/token/, et l’id doit être placé dans le corps JSON. Envoyez les champs modifiables que vous souhaitez conserver ; les champs numériques, booléens ou de chaîne omis peuvent être réinitialisés par la mise à jour.

Corps de la requête

Field	Type	Description
`id`	integer	Obligatoire. ID de la clé API renvoyé par List API keys.
`name`	string	Nom d’affichage lisible par l’utilisateur pour la clé. Doit comporter 50 caractères ou moins.
`status`	integer	Statut opérationnel. `1` active la clé pour les requêtes de modèle. `2` la désactive. `3` la marque comme expirée. `4` la marque comme quota épuisé. Les clés désactivées, expirées ou épuisées sont rejetées par les endpoints de modèle.
`expired_time`	integer	Horodatage Unix en secondes indiquant quand la clé expire. Utilisez `-1` pour aucune expiration. Un horodatage passé bloque les requêtes de modèle.
`remain_quota`	integer	Quota restant en unités de quota internes CometAPI. Si cette valeur atteint `0` et que `unlimited_quota` est `false`, les requêtes de modèle avec cette clé sont rejetées comme quota épuisé.
`unlimited_quota`	boolean	Indique si la clé contourne les vérifications de quota restant. Définissez `true` uniquement lorsque la clé doit continuer à fonctionner même si `remain_quota` est `0`.
`model_limits_enabled`	boolean	Indique s’il faut restreindre cette clé à des modèles spécifiques. Lorsque `false`, `model_limits` est ignoré.
`model_limits`	string	model ID séparés par des virgules, autorisés par cette clé lorsque `model_limits_enabled` est `true`. Utilisez les model ID renvoyés par `/v1/models` ; utilisez une chaîne vide pour aucune restriction de modèle.
`allow_ips`	string or null	Liste d’autorisation IP facultative. Fournissez une seule chaîne JSON avec des entrées séparées par des caractères de nouvelle ligne (`\n`). Chaque entrée peut être une adresse IPv4 unique, une adresse IPv6 unique, un CIDR IPv4 ou un CIDR IPv6. Utilisez `null` ou `""` pour désactiver les restrictions IP.
`group`	string	Restriction facultative de groupe de compte. Utilisez une chaîne vide pour aucun groupe explicite. Les valeurs non vides doivent être disponibles pour le compte, sinon l’API renvoie `success: false`.
`cross_group_retry`	boolean	Indique si la nouvelle tentative intergroupe est activée pour le routage automatique de groupe. Cela n’a de sens que lorsque la clé utilise un groupe avec routage automatique.

Format de la liste d’autorisation

Pour autoriser plusieurs IP ou plages CIDR, envoyez-les sous la forme d’une seule chaîne JSON avec \n entre les entrées :

{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}

Cet exemple autorise une adresse IPv4, une plage CIDR IPv4 et une plage CIDR IPv6.

Autorisations

Authorization

string

header

requis

Personal access token copied from CometAPI Console > Personal Settings. Send the raw token value; do not prefix it with Bearer.

Corps

application/json

integer

requis

Numeric API key ID returned by the list endpoint. For updates, send this value in the JSON body, not in the URL.

Exemple:

1234

name

string

User-readable display name for the API key. The backend accepts up to 50 Unicode characters; longer names return success: false with token name is too long.

Maximum string length: 50

Exemple:

"production"

status

enum<integer>

Operational status for the key. 1 enables the key for model requests, 2 disables it, 3 marks it expired, and 4 marks it quota exhausted. Disabled, expired, or exhausted keys are rejected by model endpoints.

Options disponibles:

1,

2,

3,

4

Exemple:

1

expired_time

integer

Unix timestamp in seconds when the key expires. Use -1 for no expiration. A past timestamp blocks model requests with this key.

Exemple:

-1

remain_quota

integer

Remaining quota to assign to the key in CometAPI internal quota units. If this reaches 0 while unlimited_quota is false, model requests with this key are rejected as quota exhausted.

Exemple:

100000

unlimited_quota

boolean

Whether the key bypasses remaining-quota checks. Set true only when the key should keep working even if remain_quota is 0.

Exemple:

false

model_limits_enabled

boolean

Whether to restrict this key to specific models. When true, only model IDs listed in model_limits are allowed. When false, model_limits is ignored.

Exemple:

false

model_limits

string

Comma-separated model IDs allowed by this key when model_limits_enabled is true. Use model IDs returned by /v1/models, for example <model-id-1>,<model-id-2>. Use an empty string for no model restriction.

Exemple:

""

allow_ips

string | null

Optional IP allowlist. Provide one JSON string with entries separated by newline characters (\n). Each entry can be a single IPv4 address, single IPv6 address, IPv4 CIDR, or IPv6 CIDR. Example for three allowlist entries: 198.51.100.10\n203.0.113.0/24\n2001:db8::/32. CometAPI compares the model request client IP to this list. Use null or "" to disable IP restrictions.

Exemple:

"198.51.100.10\n203.0.113.0/24\n2001:db8::/32"

group

string

Optional account group restriction. Use an empty string for no explicit group restriction. Non-empty values must be available to the account, or the API returns success: false with a no access to group message.

Exemple:

""

cross_group_retry

boolean

Whether cross-group retry is enabled for automatic group routing. This is only meaningful when the key uses an auto-routed group such as auto.

Exemple:

false

Réponse

200 - application/json

Updated API key record.

success

boolean

requis

message

string

requis

data

object

requis

Show child attributes

Supprimer une clé API

curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "group": "",
    "cross_group_retry": false
  }'

{
  "success": true,
  "message": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Documentation Index

​Corps de la requête

​Format de la liste d’autorisation

Autorisations

Corps

Réponse

Corps de la requête

Format de la liste d’autorisation