Skip to main content
POST
Use this endpoint to create an API key for automation, internal dashboards, or server-side integrations.
Generate a personal access token with the api_key:write permission at Console → Personal Settings. Send the token as the raw Authorization header value. Do not prefix it with Bearer.
The successful response includes the created API key record in data, with its numeric ID in data.id and complete API key in data.key.
Save data.key immediately. Subsequent list, detail, and update responses contain masked API keys that cannot authenticate model requests.
For model requests, use the returned data.key unchanged as Authorization: Bearer <COMETAPI_KEY>. Do not add an sk- prefix. If you did not save the complete API key, open Console → API Keys. Find the API key that you created, select Copy, and complete identity verification.

Creation response

Request body

Allowlist format

To allow multiple IPs or CIDR ranges, send them as one JSON string with \n between entries:
This example allows one IPv4 address, one IPv4 CIDR range, and one IPv6 CIDR range.

Authorizations

Authorization
string
header
required

Personal access token with the api_key:write permission, generated in CometAPI Console > Personal Settings. Send the raw token value; do not prefix it with Bearer.

Body

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
Example:

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

Example:

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

Example:

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.

Example:

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.

Example:

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.

Example:

""

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.

Example:

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

Example:

""

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.

Example:

false

Response

200 - application/json

Creation result. Successful responses include the created record and complete API key in data.

success
boolean
required

Whether the create operation succeeded.

Example:

true

message
string
required

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

Example:

""

data
object

Created API key record, including id and the complete key. Present when success is true.

Last modified on October 26, 2026