For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Key 管理

管理組織內所有成員的 API Key:三步驟代發金鑰、限制可用模型與 RPM/TPM、停用與撤銷、查看最後使用時間;以及成員如何在帳號頁面自行建立金鑰。

API Key 讓外部系統、腳本、MCP 客戶端或 AI Gateway 以某位成員的身分呼叫 MaiAgent。每把金鑰綁定一位成員與一個組織,呼叫時的權限和該成員完全相同。

金鑰有兩個管理入口:

  • 管理員:在 組織設定 → API Key 管理 查看組織內所有金鑰,為成員代發金鑰、限制可用模型與速率、停用或撤銷。

  • 成員本人:在帳號頁面的 API 金鑰 自行建立與撤銷自己的金鑰,見成員自行建立金鑰。

誰可以使用

操作
需要的條件

進入 API Key 管理,查看、代發、停用、撤銷組織內所有金鑰

角色權限 組織權限 底下的 API Key 管理權限(組織擁有者預設具備;設定方式見編輯角色權限)

在帳號頁面建立、撤銷自己的金鑰

組織內的有效成員即可,不需要額外權限

設定 開通模型、查看本月花費、使用 存取診斷

組織已啟用 AI Gateway

基本概念

  • 完整金鑰只顯示一次:建立當下會顯示完整金鑰,關閉視窗後就無法再看到,列表只顯示 前綴。遺失時請撤銷舊金鑰、重新建立。

  • 沒有數量上限:每位成員可以同時持有多把有效金鑰。輪替時可以先建立新金鑰、更新整合設定,再撤銷舊金鑰,服務不會中斷。

  • 呼叫方式:平台 API 在 HTTP 標頭帶 Authorization: Api-Key <金鑰>;AI Gateway 的 OpenAI 相容端點則帶 Authorization: Bearer <金鑰>。完整範例請見技術手冊的 API 快速上手 與 AI Gateway:OpenAI 相容 API 串接。

金鑰來源

列表的 來源 欄標示金鑰是誰簽發的,可用 篩選來源 過濾:

來源
說明

系統自動簽發

成員加入組織時由系統自動建立,名稱是一串成員 ID

本人自建

成員在帳號頁面自行建立

管理者代發

管理員在 API Key 管理 為成員建立,標籤下方會顯示代發者姓名

金鑰狀態

狀態
說明

有效

可以正常呼叫

已停用

管理員暫停使用;金鑰與用量歷史都保留,可隨時重新啟用

已過期

超過設定的到期時間

已撤銷

永久失效,無法復原

停用、過期、撤銷的金鑰,以及已被移除成員的金鑰,呼叫時都會被當成無效金鑰拒絕。

進入方式

從左側選單點選 組織設定 → API Key 管理。列表依建立時間由新到舊排列,欄位包含 擁有者、名稱、前綴、來源、狀態、開通模型・速率、最後使用、到期時間、建立時間。

  • 上方搜尋框可用名稱、擁有者或 Email 搜尋,另可依來源與狀態篩選。

  • 最後使用 是這把金鑰最近一次通過驗證的時間,同一把金鑰最多每分鐘更新一次;從未使用過的金鑰顯示 -。

建立 API Key

點選右上角 建立 API Key,會開啟三步驟的 新增 API Key 視窗。

1

選擇成員

在 選擇成員 搜尋並選擇金鑰要綁定的成員,API Key 名稱 會自動帶入「成員名稱 的 API Key」,可自行修改(最多 50 個字)。選好成員後,畫面會顯示這位成員可觸及的模型數。

不需要限制時,可直接按 略過設定,直接產生金鑰:金鑰會以預設值建立(可觸及模型全開、不限速、永不過期、立即啟用)。要設定限制則按 下一步:開通與限制。

2

開通與限制

以下設定都是選填,建立後也能在金鑰設定中調整:

欄位
作用

開通模型

這把金鑰透過 AI Gateway 對話時可用的模型,預設全選。只能在「可觸及」範圍(組織可用且 Gateway 開放的模型)內縮小,不會超出組織的可用範圍;不影響 Embedding 端點

每分鐘請求數(RPM)

這把金鑰每分鐘可呼叫的平台 API 次數,不只 AI Gateway,一般平台 API 也計入。留空為不限

每分鐘 Token 數(TPM)

這把金鑰經 AI Gateway 推論每分鐘可用的 Token 數。以每分鐘固定區間計算,單次請求可能讓當分鐘用量略超過上限,之後同一分鐘內的請求會被拒絕。留空為不限

到期時間

金鑰失效的時間,留空為永不過期

建立後立即啟用

取消勾選時,金鑰建立後為「已停用」,需要時再啟用

組織未啟用 AI Gateway 時不會出現 開通模型,其他欄位照常可設定。設定完成後按 產生金鑰。

3

產生金鑰

畫面會顯示完整金鑰,請按複製按鈕立即保存,再按 確認關閉。關閉後就無法再次檢視完整金鑰。

在「產生金鑰」之前關掉視窗的話,金鑰可能已經建立,但完整金鑰無法再顯示。請在列表找到這把金鑰並撤銷,再重新建立。

管理既有金鑰

每把金鑰右側有四個操作:

操作
說明

管理

開啟 金鑰設定與用量 側欄(見下方)

存取診斷

檢查這把金鑰為什麼呼叫不到模型,逐一列出未通過的關卡(說明見 AI Gateway 總覽)

停用/啟用

暫停或恢復這把金鑰,確認後立即生效

撤銷

永久停止這把金鑰,無法復原

金鑰設定與用量 側欄分為兩區:

  • 金鑰設定:啟用 開關、RPM、TPM、到期時間(留空=永不過期)與 開通模型,修改後按 儲存,立即生效。

  • 本月用量:本月花費(credits)、綁定成員的 成員額度,以及 呼叫的模型・花費 明細。花費與模型明細只在組織啟用 AI Gateway 時顯示。

停用和撤銷怎麼選:只是暫時不讓某個整合呼叫(例如排查異常流量),用停用,之後可以重新啟用;確定不再使用或金鑰外洩,用撤銷。

成員自行建立金鑰

成員不需要管理權限,就能為自己建立個人金鑰:

  1. 點選右上角頭像 → 帳號。

  2. 在左側目前組織名稱下方,點選 API 金鑰。

  3. 點選 建立金鑰(還沒有任何金鑰時,按鈕是 建立第一把金鑰),輸入 名稱,可選填 到期時間。

  4. 複製畫面上的完整金鑰後,按 確認關閉。

個人金鑰建立在目前切換到的組織,以您本人的身分與權限呼叫 API。如果您同時屬於多個組織,請先切換到要使用的組織再建立。

這個頁面只列出您自己建立的金鑰,可以撤銷狀態為有效的金鑰。管理者代發或系統自動簽發給您的金鑰,由組織管理員在 API Key 管理 管理。具備 API Key 管理權限 的成員,在此頁上方會看到 組織金鑰管理 連結,可直接前往組織的金鑰列表。

個人金鑰不能自行設定開通模型或 RPM/TPM;需要限制時,請管理員在 API Key 管理 調整。

常見問題

Q:每位成員只能有一把有效金鑰嗎?

不是。每位成員可以同時持有多把有效金鑰,沒有數量上限。

Q:API Key 管理頁打開是空白的?

依序確認:

  1. 您的角色具備 API Key 管理權限(見誰可以使用);只是要替自己建立金鑰,請改走成員自行建立金鑰。

  2. 左上角切換到正確的組織,再重新整理頁面;瀏覽器若有舊版頁面快取,請強制重新整理(Windows Ctrl+F5、macOS Cmd+Shift+R)。

  3. 公司網路或瀏覽器擴充功能擋下了對 API 網域的請求時,列表會載入失敗;換一個網路或無痕視窗試試。

仍然空白時,請把瀏覽器開發者工具 Console 的錯誤訊息與組織名稱提供給 MaiAgent 窗口。

Q:忘記複製完整金鑰怎麼辦?

完整金鑰只在建立時顯示一次,系統無法再取回。請撤銷這把金鑰,再重新建立一把。

Q:為什麼個人頁面看不到管理員幫我建立的金鑰?

個人頁面只顯示您自己建立的金鑰。管理者代發與系統自動簽發的金鑰,請洽有 API Key 管理權限 的管理員查看或撤銷。

Q:存取診斷 按鈕無法點選?

存取診斷需要組織已啟用 AI Gateway。未啟用時按鈕會顯示「此組織未啟用 AI Gateway,無法診斷。」;已撤銷的金鑰也無法診斷。

延伸閱讀

最後更新於

這有幫助嗎?