跳到內容
RouteAPI RouteAPI

取得完整 API Key

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

回傳與 查詢單一 API Key 相同的 Key 物件，只是 key 為完整的 sk-... 明文，而不是遮罩值。適用於第三方整合需要保存或輪替 Key、又不希望讓使用者從主控台手動複製的情境。

請求參數

Section titled “請求參數”
參數位置類型必填說明
idpathinteger是Key ID，正整數

請求範例

Section titled “請求範例”
Terminal window
curl https://www.routeapi.ai/api/open/v1/keys/12/key \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"

回應範例

Section titled “回應範例”
{
  "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 物件。

錯誤

Section titled “錯誤”
HTTPcode情境
400invalid_requestid 不是正整數
403insufficient_scope管理金鑰缺少本介面所需的權限
404not_foundKey 不存在或不屬於你
429rate_limited超過每個管理金鑰的頻率限制
429—超過依用戶端 IP 的頻率限制（敏感介面預設 100 次/20 分鐘），回應主體可能為空

其他通用錯誤碼見 開放平台 API 錯誤。

說明

Section titled “說明”
  • 每次成功呼叫都會寫入稽核事件（open_api.key.reveal），記錄 Key ID、Key 名稱與所用管理金鑰；明文 Key 不會寫入稽核或日誌。
  • 本介面回傳金鑰，因此頻率限制比一般查詢介面更嚴格。
  • 完整 Key 也會在 建立 API Key 時回傳一次。建議在建立時保存，僅在已保存的值遺失或需要輪替時呼叫本介面。
  • 查詢單一 API Key 與 列出 API Key 仍回傳遮罩值。