Skip to main content
POST
使用此端點為自動化、內部儀表板或伺服器端整合建立 API key。
Console → Personal Settings 產生 personal access token,然後將它作為原始的 Authorization 標頭值傳送。不要加上 Bearer 前綴。
建立回應只會確認操作成功,不會包含新的 key 記錄或 key 值。建立完成後,請呼叫 列出 API keys 讀取最新的 key 記錄。

請求本文

允許清單格式

若要允許多個 IP 或 CIDR 範圍,請將它們作為單一 JSON 字串傳送,並在各項目之間使用 \n
此範例允許一個 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.

範例:

""