API Key の完全な値を取得する

GET /api/open/v1/keys/:id/key

API Key を取得すると同じ Key オブジェクトを返しますが、key はマスクされた値ではなく完全な sk-... です。サードパーティ連携が、ユーザーにコンソールから値をコピーさせることなく Key を保存・ローテーションする場合に使用します。

リクエストパラメーター

パラメーター	位置	型	必須	説明
`id`	path	integer	はい	Key ID。正の整数

リクエスト例

curl https://www.routeapi.ai/api/open/v1/keys/12/key \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

レスポンス例

{
  "success": true,
  "message": "",
  "data": {
    "id": 12,
    "name": "bot",
    "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": 1,
    "created_time": 1729000000,
    "accessed_time": 1729000000,
    "expired_time": -1,
    "remain_amount": 10.00,
    "unlimited": false,
    "used_amount": 0.00,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": ""
  }
}

レスポンスには Cache-Control: no-store が付与され、ブラウザやプロキシが平文 Key をキャッシュしません。フィールドの説明は Key オブジェクトを参照してください。

エラー

HTTP	code	シナリオ
400	`invalid_request`	`id` が正の整数ではない
403	`insufficient_scope`	マネジメントキーがこのエンドポイントに必要な権限を持っていない
404	`not_found`	Key が存在しないか、あなたのものではない
429	`rate_limited`	マネジメントキーごとのレート制限を超過
429	—	クライアント IP ごとのレート制限を超過（機密性の高いエンドポイントはデフォルト 100 回/20 分）。レスポンスボディが空の場合があります

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

補足

成功した呼び出しごとに、Key の ID と名前、使用されたマネジメントキーを記録する監査イベント（open_api.key.reveal）が書き込まれます。平文の Key が監査イベントやログに書かれることはありません。
このエンドポイントは秘密情報を返すため、通常の参照系エンドポイントより厳しいレート制限が適用されます。
完全な Key は API Key を作成するでも一度返されます。作成時に保存しておき、保存した値が失われた場合やローテーションが必要な場合にのみこのエンドポイントを呼び出してください。
API Key を取得すると API Key を一覧表示するは引き続きマスクされた値を返します。