API Key を作成する

POST /api/open/v1/keys

リクエストパラメーター

リクエストボディは JSON で、Content-Type: application/json です。検証ルールはコンソールでの Key 作成と同じです。

フィールド	型	必須	デフォルト	説明
`name`	string	はい	—	名前。最大 50 文字（文字数。バイト数ではありません）。空にできません
`remain_amount`	number	いいえ	`0`	利用可能額。サイトの表示通貨、小数点以下 2 桁。`unlimited` が `false` のときに有効。負の値および上限を超える値は不可
`unlimited`	boolean	いいえ	`false`	無制限にするかどうか
`expired_time`	integer	いいえ	`-1`	有効期限、unix 秒。省略、`0`、`-1` はいずれも無期限。それ以外は未来の時刻で 9999-12-31 以前である必要があります
`model_limits_enabled`	boolean	いいえ	`false`	モデル許可リストを有効にするかどうか
`model_limits`	string	いいえ	`""`	許可するモデル。半角カンマ区切り
`allow_ips`	string	いいえ	—	許可する IP。改行区切り。省略または空文字列は制限なし

リクエスト例

curl -X POST https://www.routeapi.ai/api/open/v1/keys \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "bot",
    "remain_amount": 5.00,
    "unlimited": false,
    "expired_time": -1,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o"
  }'

レスポンス例

{
  "success": true,
  "message": "",
  "data": {
    "id": 13,
    "name": "bot",
    "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": 1,
    "created_time": 1729000000,
    "accessed_time": 1729000000,
    "expired_time": -1,
    "remain_amount": 5.00,
    "unlimited": false,
    "used_amount": 0.00,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o",
    "allow_ips": ""
  }
}

フィールドの説明は Key オブジェクトを参照してください。

エラー

HTTP	code	シナリオ
400	`invalid_request`	リクエストボディが有効な JSON ではない、または空 / `null`
400	`invalid_request`	`name` がない、空白のみ、または 50 文字を超える
400	`invalid_request`	`expired_time` が未来ではない（かつ `0` / `-1` でもない）、または 9999-12-31 より後（ミリ秒のタイムスタンプなど）
400	`invalid_request`	ユーザーごとの Key 数の上限に達している
400	`invalid_request`	`unlimited` が `false` のときに `remain_amount` が負の値か上限を超える

その他の共通エラーコードはプラットフォーム API のエラーを参照してください。

補足

unlimited が true の場合、remain_amount は無視されます。
プラットフォーム API による Key の作成は監査ログに記録されます。