Skip to Content
API 参考API 概览

API 概览

OfoxAI 提供三种协议的 API 接入方式，完全兼容各厂商官方 SDK，包括 OpenAI 最新的 Responses API。

协议推荐： OpenAI 协议推荐使用 Responses API，原生 Prompt Caching 支持更优；调用 Claude 模型推荐使用 Anthropic 原生协议，可获得完整特性和原生缓存优势。

Base URL

协议Base URL说明
OpenAI 兼容https://api.ofox.io/v1兼容 OpenAI SDK，支持 Chat Completions 和 Responses API
Anthropic 原生https://api.ofox.io/anthropic兼容 Anthropic SDK，原生 Claude 体验
Gemini 原生https://api.ofox.io/gemini兼容 Google GenAI SDK

认证

所有协议使用统一的 OfoxAI API Key，但 Header 格式因协议而异：

协议Header格式
OpenAIAuthorizationBearer sk-xxx
Anthropicx-api-keysk-xxx
Geminix-goog-api-keysk-xxx

详见 API Key 获取与使用。

可用端点

OpenAI 兼容协议

端点方法说明
/v1/chat/completionsPOST创建对话补全
/v1/responsesPOST创建模型响应（Responses API，推荐）
/v1/embeddingsPOST创建文本向量
/v1/images/generationsPOST图像生成
/v1/modelsGET列出所有可用模型
/v1/models/{provider}GET按供应商过滤模型
/v1/models/{provider}/{model_id}GET获取模型详情
/v1/models/countGET获取模型数量统计

Anthropic 原生协议

端点方法说明
/anthropic/v1/messagesPOST创建 Messages（推荐）
/anthropic/v1/modelsGET列出所有可用模型
/anthropic/v1/models/{provider}GET按供应商过滤模型
/anthropic/v1/models/{provider}/{model_id}GET获取模型详情
/anthropic/v1/models/countGET获取模型数量统计

Gemini 原生协议

端点方法说明
/gemini/v1beta/models/{model}:generateContentPOST生成内容
/gemini/v1beta/models/{model}:streamGenerateContentPOST流式生成内容
/gemini/v1beta/modelsGET列出所有可用模型
/gemini/v1beta/models/{provider}GET按供应商过滤模型
/gemini/v1beta/models/{provider}/{model_id}GET获取模型详情
/gemini/v1beta/models/countGET获取模型数量统计

类型化判断（Decisions）

对内容做是/否、单选、打分判断，返回带概率的结构化答案，详见 Decisions API 文档。

端点方法说明
/v1/decisionsPOST统一格式，也可用 OpenAI SDK 调用
/openai/v1/decisionsPOST同上，供 base URL 为 /openai/v1 的 OpenAI SDK 使用
/typesafe/v1/systemonePOSTTypeSafe 官方格式，兼容 TypeSafe SDK

视频生成（OpenRouter 兼容）

统一异步视频生成 API，详见 Video API 文档。

端点方法说明
/v1/videosPOST创建视频生成任务
/v1/videos/{id}GET查询任务状态与结果
/v1/videos/{id}DELETE取消任务

OfoxAI OpenAPI（账户）

与协议无关的平台接口，使用 OfoxAI API Key 鉴权。

端点方法说明
/v1/user/balanceGET余额查询，兼容 cc-switch

速率限制

OfoxAI 按量付费，所有用户共享统一的速率策略，无套餐差异：

限制项额度
RPM（请求/分钟）100（团队级聚合）
TPM（Token/分钟）不限

RPM 按团队聚合计算，多 Key 共享同一配额。如需更高速率配额，请联系 hi@ofox.ai 申请调整。详见 Rate Limits。

当触发限流时，API 返回 429 Too Many Requests，响应 Header 包含：

x-ratelimit-limit-requests: 100
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-6.1-sol",
  "messages": [...],
  "extra_body": {
    "provider": {
      "fallback": ["anthropic/claude-sonnet-5.5", "google/gemini-3.8-flash"]
    }
  }
}

provider 须置于请求体的 extra_body 中，放在顶层会返回 400。详见 供应商路由 和 故障回退。

最后更新于
供应商路由字段