跳至主要內容

指南

認證與權限

API Key 與權限範圍。

所有 API 請求都要在請求頭中攜帶 API Key:

Authorization: Bearer sk-axon-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • 請妥善保存 API Key。 平台只保存它的摘要,無法再次查看原文。丟失或懷疑洩露時,請聯絡我們撤銷並重新簽發。
  • 只在你的伺服器端使用 API Key。 不要把它放進網頁、App 或任何會下發到用戶裝置的程式碼中。瀏覽器原生的 EventSource 不能設定 Authorization 請求頭,事件串流也應由你的伺服器端訂閱後再轉發給前端。
  • API Key 被撤銷或已過期後,請求返回 401 invalid_api_key。

權限範圍(scope)

每個 API Key 帶有一組權限範圍,建立時預設擁有全部權限:

Scope允許的操作
sessions:read會話列表與詳情、事件歷史、事件串流
sessions:write建立、更新、刪除會話,發送訊息,取消執行
files:read檔案列表與詳情、下載檔案;發送訊息時附帶檔案
files:write上載、刪除檔案
skills:read技能列表與詳情;發送訊息時選用技能
skills:write上載、刪除技能
mcp_servers:readMCP 伺服器列表與詳情;建立會話時指定 MCP 伺服器
mcp_servers:write註冊、修改、重新探測、刪除 MCP 伺服器

模型列表不需要特定權限,任意有效的 Key 都可以調用。

缺少所需權限時返回 403 insufficient_scope。此時 Key 本身是有效的,需要換一個權限足夠的 Key。如需權限較小的 Key(例如只負責展示歷史記錄的服務只需要 sessions:read),請聯絡我們簽發。