Перейти к основному содержанию
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, статус, квоту, срок действия, ограничения по моделям, список разрешённых IP-адресов и настройки группы.
Сгенерируйте personal access token в Console → Personal Settings, затем передайте его как необработанное значение заголовка Authorization. Не добавляйте префикс Bearer.
Этот endpoint использует PUT /api/token/, а id должен находиться в теле JSON. Передавайте редактируемые поля, которые хотите сохранить; пропущенные числовые, логические или строковые поля могут быть сброшены при обновлении.

Тело запроса

FieldTypeDescription
idintegerОбязательно. ID API key, возвращаемый методом List API keys.
namestringПонятное пользователю отображаемое имя ключа. Должно содержать не более 50 символов.
statusintegerРабочий статус. 1 включает ключ для запросов к моделям. 2 отключает его. 3 помечает его как истёкший. 4 помечает, что квота исчерпана. Отключённые, истёкшие или исчерпавшие квоту ключи отклоняются endpoint’ами моделей.
expired_timeintegerUnix timestamp в секундах, когда срок действия ключа истекает. Используйте -1, если срок действия не ограничен. Timestamp в прошлом блокирует запросы к моделям.
remain_quotaintegerОставшаяся квота во внутренних единицах квоты CometAPI. Если это значение достигает 0 и unlimited_quota равно false, запросы к моделям с этим ключом отклоняются как исчерпавшие квоту.
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Необязательный список разрешённых IP-адресов. Передайте одну JSON-строку с записями, разделёнными символами новой строки (\n). Каждая запись может быть отдельным IPv4-адресом, отдельным IPv6-адресом, IPv4 CIDR или IPv6 CIDR. Используйте null или "", чтобы отключить ограничения по IP.
groupstringНеобязательное ограничение по группе аккаунта. Используйте пустую строку, если явная группа не требуется. Непустые значения должны быть доступны аккаунту, иначе API вернёт success: false.
cross_group_retrybooleanУказывает, включён ли межгрупповой повторный запрос для автоматической маршрутизации по группам. Имеет смысл только тогда, когда ключ использует группу с автоматической маршрутизацией.

Формат списка разрешённых адресов

Чтобы разрешить несколько IP-адресов или диапазонов CIDR, передайте их как одну JSON-строку, используя \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
обязательно