Створення API key - CometAPI Documentation

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.

Відповідь на створення лише підтверджує успіх. Вона не містить ні запису нового key, ні значення key. Після створення викличте List API keys, щоб прочитати запис найновішого key.

Тіло запиту

Field	Type	Description
`name`	string	Зрозуміла для користувача відображувана назва key. Має містити не більше 50 символів.
`expired_time`	integer	Unix timestamp у секундах, коли key спливає. Використовуйте `-1` для відсутності строку дії.
`remain_quota`	integer	Початкова квота у внутрішніх одиницях квоти CometAPI. Якщо значення досягає `0` і `unlimited_quota` дорівнює `false`, запити до моделей із цим key відхиляються як такі, що вичерпали квоту.
`unlimited_quota`	boolean	Чи обходить key перевірки залишку квоти. Установлюйте `true` лише тоді, коли key має продовжувати працювати, навіть якщо `remain_quota` дорівнює `0`.
`model_limits_enabled`	boolean	Чи обмежувати цей key певними моделями. Якщо `false`, `model_limits` ігнорується.
`model_limits`	string	Розділені комами model ID, дозволені для цього key, коли `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	Чи ввімкнено cross-group retry для автоматичної маршрутизації груп. Це має значення лише тоді, коли key використовує групу з автоматичною маршрутизацією.

Формат 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.

Приклад:

""

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": ""
}

​Тіло запиту

​Формат allowlist

Авторизації

Тіло

Відповідь

Тіло запиту

Формат allowlist