v1

latestOpenAPI 3.1.02026-07-267724480.0 KB

Update an API key

Update an API key by sending its ID and editable fields in the JSON body. This endpoint behaves like a full update: send fields you want to preserve because omitted numeric, boolean, or string fields can be reset.

put/api/token/

Request body

idinteger required

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

namestring

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.

status1 | 2 | 3 | 4

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.

expired_timeinteger

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

remain_quotainteger

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.

unlimited_quotaboolean

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

model_limits_enabledboolean

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.

model_limitsstring

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.

allow_ipsstring nullable

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.

groupstring

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.

cross_group_retryboolean

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.

Example request

{
  "id": 1234,
  "name": "production",
  "status": 1,
  "expired_time": -1,
  "remain_quota": 100000,
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}

Response

Updated API key record.

successboolean required

messagestring required

Example response

{
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "$COMETAPI_KEY",
    "status": 1,
    "name": "production",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
  }
}