使用文档

本页说明接入 OmniRouters API 时建议遵循的通用规则。

认证方式

API 请求使用 Bearer Token 认证：

Authorization: Bearer <your-api-key>

建议尽量在服务端保存和调用 API Key。如果密钥泄露，请尽快在控制台轮换密钥。

请求格式

多数 JSON API 使用：

Content-Type: application/json

涉及文件或素材的工作流，请以 Apifox 接口参考中的具体请求格式为准。

模型选择

模型名称需要与接口参考或控制台中展示的名称保持一致。模型是否可用，可能取决于账号配置、供应商可用性和能力分类。

常见能力分类包括：

分类	常见用途
Chat	对话、助手回复、文本生成
Image	文生图、图像编辑
Video	文生视频、图生视频、素材生成视频
Speech	文本转语音、音色生成
Music	音乐生成
Embeddings	向量生成、检索、语义搜索
Rerank	对候选文档或段落进行重排

异步生成任务

部分图像、视频、音乐工作流可能不会立即返回最终资源，而是返回任务 ID。遇到这类接口时，通常按下面流程处理：

1. 提交生成请求。
2. 保存返回的 task ID。
3. 调用对应的任务查询接口。
4. 任务进入最终状态后停止轮询。
5. 读取返回的资源 URL 或错误信息。

具体字段和状态值请以 Apifox 接口参考为准：

打开 Apifox API 参考

错误处理

请求失败时，建议在服务端记录以下信息：

• 接口路径
• Request ID，如果响应中有提供
• 模型名称
• 错误码和错误信息
• 时间戳
• 请求是否产生费用

不要记录完整 API Key、用户密钥或敏感提示词，除非有明确的运维需要并且具备合适的访问控制。

计费说明

OmniRouters 主要采用预充值余额模式。已消耗的接口调用费用通常不可退款。详细规则请查看：

计费与退款说明

技术支持

如果需要协助，可以联系：

support@omnirouters.com