以程式管理 API Key
使用存取權杖,透過介面查詢、建立、更新及刪除 API Key。
需要在應用程式自動管理 API Key 時,可依本指南接入。僅需呼叫模型或設定 SDK,請參閱 API Key 與驗證。
取得存取權杖
在個人資料頁面的「安全」區域建立存取權杖,用於管理該使用者的 API Key。
存取權杖與模型 API Key 用途不同:管理介面使用存取權杖,模型介面使用 API Key,請勿混用。
發出第一個管理請求
將 your-user-token 替換為存取權杖,查詢 API Key 清單:
curl 'https://api.agtcloud.cn/api/token/?p=1&size=20' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer your-user-token'成功後從 data.items 找到目標 Key,儲存其 id,用於取得詳情、更新或刪除。無記錄時 items 為空陣列。
清單及詳情的 key 可能是遮罩,不能直接呼叫模型;完整密鑰請到 API Keys 頁面查看。
選擇管理操作
依需要開啟對應 Reference,查看參數、回應範例或使用線上測試。
| 操作 | 用途 |
|---|---|
| 取得 API Key 清單 | 分頁查看 API Key |
| 搜尋 API Key | 依名稱或金鑰值查找 |
| 取得單一 API Key | 依 ID 讀取詳細設定 |
| 建立 API Key | 設定名稱、額度、期限及存取限制 |
| 更新 API Key | 修改設定,或單獨啟用、停用 |
| 刪除 API Key | 刪除指定 Key |
| 批次刪除 API Key | 一次刪除多個 Key |
如需查詢某個 Key 自身的剩餘額度,使用查詢 API Key 額度,驗證時填入該 Key,而不是存取權杖。
操作注意事項
更新和刪除前核對目標
一般更新可能重設省略欄位。請先讀取詳情,再完整提交需保留的設定;只需啟用或停用時,使用更新介面的「僅更新狀態」。
刪除會影響依賴該 Key 的應用程式。請核對目標 ID,勿直接使用範例 ID 刪除。
- 檢查業務結果:HTTP
200也可能是業務失敗,請同時檢查success與message。 - 避免重複寫入:建立、更新或刪除逾時後,先查詢是否生效,勿直接重複提交。
- 保護存取權杖:存放於受控伺服器環境,不要寫入前端程式、公開紀錄、截圖或程式碼儲存庫;含密鑰值的搜尋 URL 也應避免外洩。