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-2.5-flash"] } }

详见 供应商路由故障回退