メインコンテンツへスキップ
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 キーの名前、ステータス、quota、有効期限、モデル制限、IP 許可リスト、グループ設定を更新します。
Console → Personal Settings で personal access token を生成し、それを生の Authorization ヘッダー値として送信してください。Bearer を先頭に付けないでください。
このエンドポイントは PUT /api/token/ を使用し、id は JSON ボディに含めます。保持したい編集可能なフィールドを送信してください。省略した数値、boolean、または文字列フィールドは、更新時にリセットされる可能性があります。

​
リクエストボディ

FieldTypeDescription
idinteger必須。API キーを一覧表示 で返される API キー ID。
namestringキーのユーザー向け表示名。50 文字以下である必要があります。
statusinteger動作ステータス。1 は model リクエスト用にキーを有効化します。2 は無効化します。3 は期限切れとして扱います。4 は quota 枯渇として扱います。無効、期限切れ、または枯渇したキーは model エンドポイントで拒否されます。
expired_timeintegerキーの有効期限となる秒単位の Unix タイムスタンプ。期限なしの場合は -1 を使用します。過去のタイムスタンプでは model リクエストがブロックされます。
remain_quotaintegerCometAPI の内部 quota 単位での残り quota。これが 0 に達し、かつ unlimited_quota が false の場合、このキーでの model リクエストは quota 枯渇として拒否されます。
unlimited_quotabooleanこのキーが残り quota のチェックをバイパスするかどうか。remain_quota が 0 でもキーを継続して動作させる必要がある場合にのみ true を設定してください。
model_limits_enabledbooleanこのキーを特定のモデルに制限するかどうか。false の場合、model_limits は無視されます。
model_limitsstringmodel_limits_enabled が true のときにこのキーで許可される model ID のカンマ区切り文字列。/v1/models が返す model ID を使用してください。モデル制限なしの場合は空文字列を使用します。
allow_ipsstring or null任意の IP 許可リスト。改行文字 (\n) でエントリを区切った 1 つの JSON 文字列を指定します。各エントリには、単一の IPv4 アドレス、単一の IPv6 アドレス、IPv4 CIDR、または IPv6 CIDR を指定できます。IP 制限を無効にするには null または "" を使用します。
groupstring任意のアカウントグループ制限。明示的なグループを指定しない場合は空文字列を使用します。空でない値はアカウントで利用可能である必要があり、そうでない場合 API は success: false を返します。
cross_group_retryboolean自動グループルーティングのためのクロスグループ再試行が有効かどうか。これはキーが自動ルーティングされるグループを使用している場合にのみ意味があります。

​
許可リストの形式

複数の IP または CIDR 範囲を許可するには、各エントリの間に \n を入れた 1 つの JSON 文字列として送信します。 
{
  "allow_ips": "198.51.100.10\n203.0.113.0/24\n2001:db8::/32"
}
この例では、1 つの IPv4 アドレス、1 つの IPv4 CIDR 範囲、1 つの 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
必須