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 | 格式 |
|---|---|---|
| OpenAI | Authorization | Bearer sk-xxx |
| Anthropic | x-api-key | sk-xxx |
| Gemini | x-goog-api-key | sk-xxx |
詳見 認證指南。
可用端點
OpenAI 相容協議
| 端點 | 方法 | 說明 |
|---|---|---|
/v1/chat/completions | POST | 建立對話補全 |
/v1/embeddings | POST | 建立文字向量 |
/v1/models | GET | 列出可用模型 |
/v1/models/{model_id} | GET | 取得模型詳情 |
/v1/images/generations | POST | 圖像生成 |
Anthropic 原生協議
| 端點 | 方法 | 說明 |
|---|---|---|
/anthropic/v1/messages | POST | 建立 Messages |
Gemini 原生協議
| 端點 | 方法 | 說明 |
|---|---|---|
/gemini/v1beta/models/{model}:generateContent | POST | 生成內容 |
/gemini/v1beta/models/{model}:streamGenerateContent | POST | 串流生成內容 |
速率限制
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