Перейти до основного вмісту
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
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt

Use this file to discover all available pages before exploring further.

Використовуйте цей endpoint, щоб оновити назву API key, статус, квоту, термін дії, обмеження моделей, allowlist IP-адрес і налаштування груп.
Згенеруйте personal access token у Console → Personal Settings, а потім передайте його як необроблене значення заголовка Authorization. Не додавайте префікс Bearer.
Цей endpoint використовує PUT /api/token/, а id має бути в JSON body. Передайте редаговані поля, які хочете зберегти; пропущені числові, булеві або рядкові поля можуть бути скинуті під час оновлення.

​
Body запиту

FieldTypeDescription
idintegerОбов’язкове. ID API key, повернений методом List API keys.
namestringЗрозуміла користувачу відображувана назва ключа. Має містити не більше 50 символів.
statusintegerРобочий статус. 1 вмикає ключ для model requests. 2 вимикає його. 3 позначає його як прострочений. 4 позначає, що його квоту вичерпано. Вимкнені, прострочені або вичерпані ключі відхиляються model endpoints.
expired_timeintegerUnix timestamp у секундах, коли строк дії ключа спливає. Використовуйте -1 для відсутності строку дії. Timestamp у минулому блокує model requests.
remain_quotaintegerЗалишкова квота у внутрішніх одиницях квоти CometAPI. Якщо це значення досягає 0 і unlimited_quota дорівнює false, model requests з цим ключем відхиляються як такі, що вичерпали квоту.
unlimited_quotabooleanЧи обходить ключ перевірки залишкової квоти. Установлюйте true лише тоді, коли ключ має продовжувати працювати, навіть якщо remain_quota дорівнює 0.
model_limits_enabledbooleanЧи обмежувати цей ключ конкретними моделями. Якщо false, model_limits ігнорується.
model_limitsstringРозділений комами список model ID, дозволених для цього ключа, коли model_limits_enabled дорівнює true. Використовуйте model ID, повернуті /v1/models; використовуйте порожній рядок, якщо обмеження моделей не потрібне.
allow_ipsstring or nullНеобов’язковий allowlist IP-адрес. Передайте один JSON string із записами, розділеними символами нового рядка (\n). Кожен запис може бути окремою IPv4-адресою, окремою IPv6-адресою, IPv4 CIDR або IPv6 CIDR. Використовуйте null або "", щоб вимкнути IP-обмеження.
groupstringНеобов’язкове обмеження групи акаунта. Використовуйте порожній рядок, якщо явна група не потрібна. Непорожні значення мають бути доступні акаунту, інакше API поверне success: false.
cross_group_retrybooleanЧи ввімкнено cross-group retry для автоматичної маршрутизації груп. Це має сенс лише тоді, коли ключ використовує групу з автоматичною маршрутизацією.

​
Формат allowlist

Щоб дозволити кілька IP-адрес або діапазонів CIDR, передайте їх як один JSON string із \n між записами: 
{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
Цей приклад дозволяє одну IPv4-адресу, один IPv4 CIDR-діапазон і один IPv6 CIDR-діапазон.

Авторизації

​
Authorization
string
header
обов'язково

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

Тіло

application/json
​
id
integer
обов'язково

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

Приклад:

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
Приклад:

"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.

Доступні опції:
1,
2,
3,
4
Приклад:

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.

Приклад:

-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.

Приклад:

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.

Приклад:

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.

Приклад:

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.

Приклад:

""

​
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.

Приклад:

"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.

Приклад:

""

​
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.

Приклад:

false

Відповідь

200 - application/json

Updated API key record.

​
success
boolean
обов'язково
​
message
string
обов'язково
​
data
object
обов'язково