跳轉到主要內容
PUT
/
api
/
token
curl -X PUT https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 1234,
    "name": "production-renamed",
    "status": 1,
    "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": "",
  "data": {
    "id": 1234,
    "user_id": 5678,
    "key": "<COMETAPI_KEY>",
    "status": 1,
    "name": "production-renamed",
    "created_time": 1766102400,
    "accessed_time": 1766102400,
    "expired_time": -1,
    "remain_quota": 100000,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": null,
    "used_quota": 0,
    "group": "",
    "cross_group_retry": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt

Use this file to discover all available pages before exploring further.

使用此端點可更新 API key 的名稱、狀態、配額、到期時間、模型限制、IP 允許清單，以及群組設定。
在 Console → Personal Settings 產生 personal access token，然後將其作為原始 Authorization 標頭值傳送。不要加上 Bearer 前綴。
此端點使用 PUT /api/token/，且 id 必須放在 JSON 主體中。請一併傳送你想保留的可編輯欄位；若省略數值、布林或字串欄位，更新時可能會將其重設。

​
請求主體

FieldTypeDescription
idinteger必填。由列出 API keys回傳的 API key ID。
namestring供使用者辨識的 key 顯示名稱。長度不得超過 50 個字元。
statusinteger運作狀態。1 會啟用此 key 以進行模型請求。2 會停用。3 表示已過期。4 表示配額已耗盡。已停用、已過期或已耗盡的 key 會被模型端點拒絕。
expired_timeinteger此 key 到期的 Unix 秒級時間戳。使用 -1 表示永不到期。若為過去時間戳，將封鎖模型請求。
remain_quotaintegerCometAPI 內部配額單位中的剩餘配額。若此值達到 0 且 unlimited_quota 為 false，使用此 key 的模型請求會因配額耗盡而被拒絕。
unlimited_quotaboolean此 key 是否略過剩餘配額檢查。僅在即使 remain_quota 為 0 也應持續可用時，才設為 true。
model_limits_enabledboolean是否將此 key 限制為只能使用特定模型。當為 false 時，會忽略 model_limits。
model_limitsstring當 model_limits_enabled 為 true 時，此 key 允許使用的 model ID，以逗號分隔。請使用 /v1/models 回傳的 model ID；若不限制模型，請使用空字串。
allow_ipsstring or null可選的 IP 允許清單。請提供一個 JSON 字串，條目之間以換行字元（\n）分隔。每個條目可以是單一 IPv4 位址、單一 IPv6 位址、IPv4 CIDR 或 IPv6 CIDR。使用 null 或 "" 可停用 IP 限制。
groupstring可選的帳戶群組限制。若不指定群組，請使用空字串。非空值必須是該帳戶可用的群組，否則 API 會回傳 success: false。
cross_group_retryboolean是否啟用跨群組重試以進行自動群組路由。只有當此 key 使用自動路由群組時，此欄位才有意義。

​
允許清單格式

若要允許多個 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
​
id
integer
必填

Numeric API key ID returned by the list endpoint. For updates, send this value in the JSON body, not in the URL.

範例:

1234

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

​
status
enum<integer>

Operational status for the key. 1 enables the key for model requests, 2 disables it, 3 marks it expired, and 4 marks it quota exhausted. Disabled, expired, or exhausted keys are rejected by model endpoints.

可用選項:
1,
2,
3,
4
範例:

1

​
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

Remaining quota to assign to the 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

Updated API key record.

​
success
boolean
必填
​
message
string
必填
​
data
object
必填