Skip to Content
API 參考API 概覽

API 概覽

OfoxAI 提供三種協議的 API 接入方式,完全相容各廠商官方 SDK。

Base URL

協議Base URL說明
OpenAI 相容https://api.ofox.ai/v1相容 OpenAI SDK,支援所有模型
Anthropic 原生https://api.ofox.ai/anthropic相容 Anthropic SDK,原生 Claude 體驗
Gemini 原生https://api.ofox.ai/gemini相容 Google GenAI SDK

認證

所有協議使用統一的 OfoxAI API Key,但 Header 格式因協議而異:

協議Header格式
OpenAIAuthorizationBearer sk-xxx
Anthropicx-api-keysk-xxx
Geminix-goog-api-keysk-xxx

詳見 認證指南

可用端點

OpenAI 相容協議

端點方法說明
/v1/chat/completionsPOST建立對話補全
/v1/embeddingsPOST建立文字向量
/v1/modelsGET列出可用模型
/v1/models/{model_id}GET取得模型詳情
/v1/images/generationsPOST圖像生成

Anthropic 原生協議

端點方法說明
/anthropic/v1/messagesPOST建立 Messages

Gemini 原生協議

端點方法說明
/gemini/v1beta/models/{model}:generateContentPOST生成內容
/gemini/v1beta/models/{model}:streamGenerateContentPOST串流生成內容

速率限制

OfoxAI 按量付費,所有使用者共享統一的速率策略,無套餐差異:

限制項額度
RPM(請求/分鐘)200
TPM(Token/分鐘)不限

如需更高速率配額,請聯繫 OfoxAI 支援  申請調整。

當觸發限流時,API 回傳 429 Too Many Requests,回應 Header 包含:

x-ratelimit-limit-requests: 200 x-ratelimit-remaining-requests: 0 x-ratelimit-reset-requests: 1s

錯誤碼

所有協議回傳統一的 HTTP 狀態碼:

狀態碼說明常見原因
200成功
400請求錯誤參數格式錯誤、缺少必填欄位
401認證失敗API Key 無效或過期
403權限不足帳戶無權存取該模型
404資源不存在模型 ID 錯誤
429觸發限流超過速率限制
500伺服器錯誤內部錯誤,請重試
502上游錯誤模型供應商服務異常
503服務不可用服務維護中

錯誤回應格式

{ "error": { "code": "invalid_api_key", "message": "提供的 API Key 無效,請檢查後重試。", "type": "authentication_error" } }

OfoxAI 擴充參數

OfoxAI 在標準協議基礎上提供擴充參數,用於進階路由和回退控制:

{ "model": "openai/gpt-4o", "messages": [...], "provider": { "routing": "cost", "fallback": ["anthropic/claude-sonnet-4.5", "google/gemini-3-flash-preview"] } }

詳見 供應商路由故障回退

Last updated on