驗證與 API Key
如何傳送 API Key,以及如何限制每組 Key 能做的事。
每個請求都要帶上你的一組 API Key。請在控制台的 API Key 頁面建立與管理 Key。
傳送 Key
| 端點 | 標頭 |
|---|---|
| 所有端點 | Authorization: Bearer sk-... |
/v1/messages(Anthropic 格式) | 也接受 x-api-key: sk-... |
傳入 api_key / apiKey 時,官方 SDK 會自動設定正確的標頭。
請像對待密碼一樣保管 Key。把 Key 放在環境變數或密鑰管理服務中,切勿寫進用戶端程式碼或公開的儲存庫。如果 Key 外洩,請在控制台刪除它並建立一組新的。
Key 限制
在控制台的 API Key 頁面按 建立 Key,或按既有 Key 旁的 編輯,即可設定它的 限制。四項限制各有一個開關:關閉即不限制,打開後再填值。變更會立即生效。
| 限制 | 作用 |
|---|---|
| 到期 | 可選 7 天、30 天、90 天、1 年,或選自訂指定日期。Key 在到期當天 23:59(當地時間)失效,請求回傳 401。 |
| 預算上限 | 以美元計的金額。這組 Key 花到這個金額即停用,請求回傳 401。編輯 Key 時,這裡是它剩餘可用的額度,修改即重設。 |
| 允許的模型 | 從模型目錄勾選,目錄裡沒有的可輸入模型 ID 新增,最多 50 個。呼叫其他模型回傳 403。 |
| IP 允許清單 | 每行一個 IP 位址或 CIDR 範圍,最多 20 行。來自其他位址的請求回傳 403。 |
編輯 Key 時,沒有修改的到期與預算上限維持原樣。在 Key 清單中,預算 欄顯示每組 Key 的剩餘與已用金額;Key 碰到上述限制後,狀態 欄會顯示 已到期 或 預算用盡。預算上限永遠不會讓 Key 花費超過你的餘額。
每個應用程式一組 Key
為每個應用程式、環境或團隊成員各發一組 Key。這樣你就能在 Key 清單中看到各自的花費、用預算上限封頂,並在不影響其他 Key 的情況下刪除它。