API Key を一覧表示する

GET /api/open/v1/keys

リクエストパラメーター

パラメーター	位置	型	必須	デフォルト	説明
p	query	integer	いいえ	1	ページ番号。1–1000000
page_size	query	integer	いいえ	10	1 ページあたりの件数。1–1000
name	query	string	いいえ	—	Key 名の完全一致で絞り込み。複数指定する場合はパラメーターを繰り返します（?name=a&name=b）。名前にカンマを含められるためカンマ区切りは未対応

複数値パラメーターはそれぞれ最大 50 個までです。超えると 400 invalid_request を返します。name を指定した場合、total は絞り込み後の件数です。明示的に指定した不正な p / page_size は 400 を返します。詳細は ページネーション を参照してください。

リクエスト例

curl "https://www.routeapi.ai/api/open/v1/keys?p=1&page_size=20&name=bot" \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

レスポンス例

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": 12,
        "name": "bot",
        "key": "sk-abcd**********wxyz",
        "status": 1,
        "created_time": 1729000000,
        "accessed_time": 1729000000,
        "expired_time": -1,
        "remain_amount": 10.00,
        "unlimited": false,
        "used_amount": 0.00,
        "model_limits_enabled": true,
        "model_limits": "gpt-4o,gpt-4o-mini",
        "allow_ips": ""
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}

レスポンスフィールド

フィールド	型	説明
items	array	Key オブジェクトのリスト。ID の降順（新しい順）
total	integer	絞り込み条件に一致する Key の総数
page	integer	現在のページ番号
page_size	integer	実際に適用された 1 ページあたりの件数

Key オブジェクト

プラットフォーム API で Key を返すすべてのエンドポイントは、同じ構造を使用します。

フィールド	型	説明
id	integer	Key ID。他のエンドポイントの :id として使用
name	string	名前
key	string	sk- プレフィックス付きの Key の値。作成エンドポイント と API Key の完全な値を取得する 以外ではマスクされた値
status	integer	1 有効、2 無効（手動で停止した状態。再び有効にできます）、3 期限切れ、4 利用可能額を使い切った。更新エンドポイント で有効化／停止できます（1 / 2 のみ）。
created_time	integer	作成日時、unix 秒
accessed_time	integer	最終使用日時、unix 秒
expired_time	integer	有効期限、unix 秒。-1 は無期限
remain_amount	number	残りの利用可能額。小数点以下 2 桁。unlimited が true の場合は意味を持ちません
unlimited	boolean	無制限かどうか
used_amount	number	使用済み金額。小数点以下 2 桁
model_limits_enabled	boolean	モデル許可リストが有効かどうか
model_limits	string	許可するモデル。半角カンマ区切り
allow_ips	string	許可する IP。改行区切り。空文字列は制限なし

補足

• 金額はサイトの表示通貨で表されます。残高を照会する を参照してください。
• 共通エラーコードは プラットフォーム API のエラー を参照してください。