列出 API Key
GET /api/open/v1/keys| 參數 | 位置 | 類型 | 必填 | 預設值 | 說明 |
|---|---|---|---|---|---|
p | query | integer | 否 | 1 | 頁碼,取值 1–1000000 |
page_size | query | integer | 否 | 10 | 每頁筆數,取值 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 | 實際生效的每頁筆數 |
Key 物件
Section titled “Key 物件”開放平台 API 中所有回傳 Key 的介面都使用同一結構:
| 欄位 | 類型 | 說明 |
|---|---|---|
id | integer | Key ID,用於其他介面的 :id |
name | string | 名稱 |
key | string | Key 值,sk- 前綴;除 建立介面 與 取得完整 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 | 剩餘可用金額,兩位小數;unlimited 為 true 時無意義 |
unlimited | boolean | 是否無限額度 |
used_amount | number | 已用金額,兩位小數 |
model_limits_enabled | boolean | 是否啟用模型白名單 |
model_limits | string | 允許的模型,以半形逗號分隔 |
allow_ips | string | 允許的 IP,以換行分隔;空字串表示不限制 |
- 金額使用站點顯示幣別,見 查詢餘額。
- 通用錯誤碼見 開放平台 API 錯誤。