Создать API key

POST

api

token

curl https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "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": ""
}

Используйте этот endpoint, чтобы создать API key для автоматизации, внутренних панелей мониторинга или серверных интеграций.

Сгенерируйте personal access token в Console → Personal Settings, затем передайте его как необработанное значение заголовка Authorization. Не добавляйте префикс Bearer.

Ответ на создание только подтверждает успех. Он не включает новую запись ключа или значение ключа. После создания вызовите List API keys, чтобы прочитать запись самого нового ключа.

Тело запроса

Field	Type	Description
`name`	string	Отображаемое имя ключа, понятное пользователю. Должно содержать не более 50 символов.
`expired_time`	integer	Unix timestamp в секундах, когда срок действия ключа истекает. Используйте `-1` для отсутствия срока действия.
`remain_quota`	integer	Начальная квота во внутренних единицах квоты CometAPI. Если она достигнет `0` и `unlimited_quota` равно `false`, запросы к моделям с этим ключом будут отклоняться как исчерпавшие квоту.
`unlimited_quota`	boolean	Определяет, должен ли ключ обходить проверки оставшейся квоты. Установите `true`, только если ключ должен продолжать работать, даже когда `remain_quota` равно `0`.
`model_limits_enabled`	boolean	Определяет, следует ли ограничить этот ключ конкретными моделями. Когда `false`, `model_limits` игнорируется.
`model_limits`	string	Список разрешенных этим ключом model ID, разделенных запятыми, когда `model_limits_enabled` равно `true`. Используйте model ID, возвращаемые `/v1/models`; используйте пустую строку, если ограничения по моделям не нужны.
`allow_ips`	string or null	Необязательный allowlist IP-адресов. Передайте одну JSON-строку с записями, разделенными символами новой строки (`\n`). Каждая запись может быть отдельным IPv4-адресом, отдельным IPv6-адресом, IPv4 CIDR или IPv6 CIDR. Используйте `null` или `""`, чтобы отключить ограничения по IP.
`group`	string	Необязательное ограничение по группе учетной записи. Используйте пустую строку, если явная группа не нужна. Непустые значения должны быть доступны учетной записи, иначе API вернет `success: false`.
`cross_group_retry`	boolean	Определяет, включен ли межгрупповой повтор для автоматической маршрутизации по группам. Это имеет смысл только тогда, когда ключ использует группу с автоматической маршрутизацией.

Формат allowlist

Чтобы разрешить несколько 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

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"

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

Starting quota for the new 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

Create result.

success

boolean

обязательно

Whether the create operation succeeded.

Пример:

true

message

string

обязательно

Backend status message. The value is usually an empty string on success.

Пример:

""

Список API-ключей

Получить API-ключ

curl https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "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": ""
}

Модерация контента

API-ключи

Тело запроса

Формат allowlist

Авторизации

Тело

Ответ

​Тело запроса

​Формат allowlist

Авторизации

Тело

Ответ

Тело запроса

Формат allowlist