API キーを作成する

POST

api

token

curl https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "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": ""
}

このエンドポイントを使用して、自動化、社内ダッシュボード、またはサーバーサイド統合向けの API キーを作成します。

Console → Personal Settings で personal access token を生成し、その生の値を Authorization ヘッダーとして送信してください。Bearer を先頭に付けないでください。

作成レスポンスは成功のみを確認するもので、新しいキーレコードやキーの値は含まれません。作成後に、API キーを一覧表示するを呼び出して最新のキーレコードを取得してください。

リクエスト本文

Field	Type	Description
`name`	string	キーのユーザー向け表示名です。50 文字以内である必要があります。
`expired_time`	integer	キーの有効期限となる秒単位の Unix タイムスタンプです。無期限にするには `-1` を使用します。
`remain_quota`	integer	CometAPI の内部 quota 単位での初期 quota です。これが `0` に達し、かつ `unlimited_quota` が `false` の場合、このキーを使った model リクエストは quota 枯渇として拒否されます。
`unlimited_quota`	boolean	このキーが残り quota のチェックを回避するかどうかです。`remain_quota` が `0` でもキーを引き続き機能させる必要がある場合にのみ `true` を設定してください。
`model_limits_enabled`	boolean	このキーを特定の model に制限するかどうかです。`false` の場合、`model_limits` は無視されます。
`model_limits`	string	`model_limits_enabled` が `true` のときに、このキーで許可される model ID のカンマ区切り一覧です。`/v1/models` が返す model ID を使用してください。model 制限なしにするには空文字列を使用します。
`allow_ips`	string or null	任意の IP 許可リストです。改行文字（`\n`）で各エントリを区切った 1 つの JSON 文字列を指定します。各エントリには、単一の IPv4 アドレス、単一の IPv6 アドレス、IPv4 CIDR、または IPv6 CIDR を指定できます。IP 制限を無効にするには `null` または `""` を使用します。
`group`	string	任意のアカウント group 制限です。明示的な group を指定しない場合は空文字列を使用します。空でない値はアカウントで利用可能である必要があり、そうでない場合 API は `success: false` を返します。
`cross_group_retry`	boolean	自動 group ルーティングのために cross-group retry が有効かどうかです。これはキーが自動ルーティングされる group を使用している場合にのみ意味があります。

許可リストの形式

複数の 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

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.

例:

""

API キーを一覧表示

API キーを取得

curl https://api.cometapi.com/api/token/ \
  -H "Authorization: your-access-token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production",
    "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": ""
}

コンテンツモデレーション

APIキー

リクエスト本文

許可リストの形式

承認

ボディ

レスポンス

​リクエスト本文

​許可リストの形式

承認

ボディ

レスポンス

リクエスト本文

許可リストの形式