v1

latestOpenAPI 3.1.02026-07-267724480.0 KB

Create a new API key

Create an API key for the authenticated account. The response confirms success but does not include the new key record or key value; call the list endpoint after creation to read the record.

post/api/token/

Request body

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.

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

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.

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

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

Response

Create result.

successboolean required

Whether the delete operation succeeded.

messagestring required

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

Example response

{
  "success": true
}