AIXHUBDocs
API 接入

API 接入

選擇 AIXHUB 協定或 Python SDK、使用正確網址層級,並在用量記錄驗證第一筆請求。

要撰寫應用程式或服務程式碼時,請從本區開始。若要設定現成桌面或命令列工具,請改用客戶端指南;每個客戶端組合網址與儲存憑證的方式都不相同。

前置條件

選擇接入方式

目標協定或程式庫起點
傳送原始 OpenAI 相容請求OpenAI ResponsesResponses API
傳送原始 Anthropic 相容請求Anthropic MessagesMessages API
使用 OpenAI Python 套件透過 SDK 呼叫 OpenAI ResponsesOpenAI Python SDK
使用 Anthropic Python 套件透過 SDK 呼叫 Anthropic MessagesAnthropic Python SDK
決定金鑰傳送方式Bearer 或 x-api-key認證與 Base URL

每個應用程式或服務都建立獨立 AIXHUB 金鑰。不要重複使用 Codex、Claude Code、Cherry Studio 或其他客戶端的金鑰。

使用正確網址層級

設定值精確位址使用時機
AIXHUB 根位址https://api.aixhub.orgAnthropic SDK 或客戶端要求 Base URL,並會自行附加 /v1/messages
OpenAI 相容 Base URLhttps://api.aixhub.org/v1OpenAI SDK 或客戶端會自行附加 /responses 等資源路徑
Responses 完整端點https://api.aixhub.org/v1/responses傳送原始 Responses HTTP 請求
Messages 完整端點https://api.aixhub.org/v1/messages傳送原始 Anthropic Messages HTTP 請求

Base URL 不是完整端點。貼上設定值前,先核對欄位名稱與所選協定。不可產生 /v1/v1,也不要把 /responses/messages 貼進會自行附加資源路徑的欄位。

操作步驟

  1. 建立專用 API 金鑰
  2. 模型路由複製完整相容模型 ID;範例用 panel-model-id 作為明顯替代值。
  3. 認證與 Base URL在 Bash 或 PowerShell 執行一筆最小請求。
  4. 第一筆輸入保持固定且不呼叫工具:只回覆 OK。
  5. 讀取完整回應或串流終止事件後,才判定請求成功。
  6. 開啟用量記錄,核對請求時間、模型、狀態,以及介面有顯示時的協定。

驗證結果

預期應用程式輸出:

OK

只看到文字回應不能證明實際路由。本機回應必須與 AIXHUB 用量記錄一致。

常見問題

正式環境檢查清單

  • 把金鑰放在伺服器端秘密管理服務或受保護環境,不可放進公開瀏覽器程式碼。
  • 為生成請求設定適當的連線與讀取逾時。
  • 記錄請求時間、所選模型、HTTP 狀態,以及實際回傳時的 request ID;預設不可記錄認證標頭或完整提示內容。
  • 遵守 Retry-After 並限制重試次數。400、401、403 與 413 必須先修正,不可原樣重送。
  • 串流必須讀到成功終止事件才能算成功,不能只看最初的 HTTP 200。
  • 中斷後重新產生前先查看用量,避免網路錯誤造成重複執行或計費。

錯誤封裝與重試邊界請參考錯誤代碼

下一步

官方資料

最後核對:2026-07-14

本頁目錄