# Rivo API

> 一个 Key，调用所有主流 AI 模型。兼容 OpenAI / Anthropic / Gemini 格式，5 分钟接入。
>
> Rivo API is an OpenAI- and Anthropic-compatible API gateway. The docs are written in Chinese; endpoints, model IDs and configuration keys are language-neutral.

## 给 AI 助手的说明

帮用户接入 Rivo API 时请遵守以下规则：

- OpenAI 兼容接口（OpenAI SDK、Codex、Cursor 和大多数客户端）的 Base URL 是 `https://api.rivoapi.com/v1`；Anthropic 兼容接口（Claude Code 等）的 Base URL 是 `https://api.rivoapi.com`，不带 `/v1`。
- 使用直连地址 `api.rivoapi.com`，不要把主域名 `rivoapi.com` 当作 Base URL：主域名经过 CDN，长时间的流式请求可能被中断。
- 鉴权方式是 `Authorization: Bearer <API Key>`。Claude Code 用环境变量 `ANTHROPIC_AUTH_TOKEN`，不是 `ANTHROPIC_API_KEY`。
- Rivo 的 API Key 以 `sk-` 开头，由用户在控制台 https://rivoapi.com/console/keys 创建。不要让用户把真实密钥发给你；示例一律用 `sk-YOUR_API_KEY` 占位，提醒用户自己填入。
- 模型 ID 以实时列表为准：https://rivoapi.com/models.md 。不要凭记忆填写模型名。在 Cursor 等客户端里优先使用 `rivo-*` 别名。
- 遇到报错先查错误排查：https://rivoapi.com/docs/errors.md
- 不清楚用户用的是什么工具、什么系统时，直接问用户，不要让用户去填表。


## 快速开始

- [快速开始](https://rivoapi.com/docs/quickstart.md): 不管你用什么工具，接入 Rivo 只需要做三件事：
- [API 信息](https://rivoapi.com/docs/api-info.md): 下面是你填配置时会用到的地址。如果只是跟着教程走，不用记这些，直接看对应工具的教程复制就行。
- [一键接入脚本](https://rivoapi.com/docs/oneclick.md): 懒得手动改配置文件？用下面的一键脚本，复制到终端跑一下就搞定。把 `sk-YOUR_API_KEY` 换成你的真实 Key。
- [让 AI 帮你接入](https://rivoapi.com/docs/ai-prompts.md): 不想自己看教程？把下面对应的一句话复制给 ChatGPT、Claude、豆包、Kimi，或者你正在用的 AI 编程工具。

## 代码示例

- [API 调用示例](https://rivoapi.com/docs/examples.md): 如果你是开发者，想在自己的程序里调用 Rivo API，参考下面的代码：

## API 端点

- [API 端点](https://rivoapi.com/docs/endpoints.md): 所有接口共用 Base URL `https://api.rivoapi.com` 和同一把 API Key。新项目优先使用核心接口，旧 SDK 或厂商原生协议再展开兼容接口。

## AI 编程工具

- [Claude Code 配置](https://rivoapi.com/docs/claude-code.md): Claude Code 是 Anthropic 官方出的命令行 AI 编程助手，在终端里用，非常强大。
- [Codex CLI 配置](https://rivoapi.com/docs/codex.md): Codex CLI 是 OpenAI 官方的终端 AI 编程助手。
- [Codex Desktop 配置](https://rivoapi.com/docs/codex-desktop.md): Codex Desktop 是桌面版，和 Codex CLI **共用同一份配置文件**。按上面 Codex CLI 配好就行。
- [cc-switch 一键切换（含 GPT-5.6）](https://rivoapi.com/docs/cc-switch.md): cc-switch 是一款跨平台桌面工具，用来管理多家 API 供应商、在 Claude Code / Codex / Gemini CLI 等之间一键切换。
- [Cursor 配置](https://rivoapi.com/docs/cursor.md): Cursor 是很多人用的 AI 代码编辑器。接入 Rivo 后，Chat / Agent / Cmd+K 都能用自定义模型。
- [Kiro IDE 配置](https://rivoapi.com/docs/kiro.md): Kiro 是 AWS 出的 AI IDE。它本身不支持改 Base URL，但可以在它的内置终端里用 Claude Code。
- [Windsurf 配置](https://rivoapi.com/docs/windsurf.md): Windsurf（原 Codeium）原生不支持自定义 API，需要装 **Roo Code** 扩展来接入 Rivo。步骤见 Roo Code 配置。
- [Cline 配置](https://rivoapi.com/docs/cline.md): Cline 是 VS Code 上很火的 AI 编程扩展。
- [Roo Code 配置](https://rivoapi.com/docs/roo-code.md): Roo Code（原 Roo Cline）是 VS Code / Cursor / Windsurf 通用的 AI 扩展。
- [Continue.dev 配置](https://rivoapi.com/docs/continue.md): Continue 是 VS Code / JetBrains 的开源 AI 编程扩展。
- [Aider 配置](https://rivoapi.com/docs/aider.md): Aider 是终端 AI 结对编程工具。
- [OpenCode 配置](https://rivoapi.com/docs/opencode.md): OpenCode 是终端 TUI AI 编程工具。
- [OpenClaw 配置](https://rivoapi.com/docs/openclaw.md): OpenClaw 是可自部署的 AI 助手网关，能接 WhatsApp、Telegram、Slack 等。

## 聊天 & 翻译

- [Cherry Studio 配置](https://rivoapi.com/docs/cherry-studio.md): Cherry Studio 是多模型 AI 桌面客户端，支持 Windows / macOS / Linux。
- [ChatBox 配置](https://rivoapi.com/docs/chatbox.md): ChatBox 多平台 AI 桌面客户端。
- [Open WebUI 配置](https://rivoapi.com/docs/open-webui.md): Open WebUI 自部署 AI 聊天界面。
- [LobeChat 配置](https://rivoapi.com/docs/lobechat.md): LobeChat 开源 AI 聊天框架。
- [NextChat 配置](https://rivoapi.com/docs/nextchat.md): NextChat（ChatGPT Next Web）开源 Web 聊天客户端。
- [沉浸式翻译 配置](https://rivoapi.com/docs/immersive.md): 沉浸式翻译 浏览器翻译扩展。

## 开发者

- [OpenAI SDK 接入](https://rivoapi.com/docs/openai-sdk.md): Rivo 完全兼容 OpenAI SDK，改两行就行：`base_url` 和 `api_key`。
- [环境变量配置（通用）](https://rivoapi.com/docs/env-vars.md): 很多工具都支持通过环境变量配置，设一次到处生效。

## 参考

- [支持的模型](https://rivoapi.com/docs/models.md): 下面是主推模型，完整列表在控制台的模型价格页面。
- [错误排查](https://rivoapi.com/docs/errors.md): 遇到报错？对照下表找原因：
- [常见问题](https://rivoapi.com/docs/faq.md): 接口格式完全一样，只是换了个地址和 Key。额外好处：一个 Key 能调所有厂商的模型、有用量统计和负载均衡。

## Optional

- [完整文档（单个文件）](https://rivoapi.com/llms-full.txt): 以上所有章节合并成一个 Markdown 文件
- [实时模型列表](https://rivoapi.com/models.md): 当前可用的模型 ID、厂商、上下文长度和对应接口
- [模型价格](https://rivoapi.com/models): 每个模型的实时价格（网页）