# RouteMux

> AI 网关:用 OpenAI / Anthropic / Vertex 兼容协议,一个 API 和一个 key 调用多家模型。
> 预付费钱包计费,**只对成功请求计费**,未使用余额随时可退。

本文件是给 AI 编程工具(Claude Code / Codex / Cursor 等)读的索引。
人读的文档在 https://routemux.com。

## Base URL

- 网关(用 API key 调模型):https://api.routemux.com
- 站内 API(浏览器会话):https://routemux.com/api

## 认证

HTTP 头 `Authorization: Bearer <你的 RouteMux API key>`。
key 在控制台 https://routemux.com/console/keys 创建,前缀 `sk-`(历史 key 的 `rmx_live_` 仍受理)。

## 最快跑通的一次调用

把现有 OpenAI SDK 的 base_url 换掉即可,**其余代码不用动**:

```python
from openai import OpenAI

client = OpenAI(base_url="https://api.routemux.com/v1", api_key="sk-...")
resp = client.chat.completions.create(
    model="openai/gpt-5.6-sol",
    messages=[{"role": "user", "content": "Hello"}],
)
```

```bash
curl https://api.routemux.com/v1/chat/completions \
  -H "Authorization: Bearer sk-..." \
  -H "Content-Type: application/json" \
  -d '{"model":"openai/gpt-5.6-sol","messages":[{"role":"user","content":"Hello"}]}'
```

## 端点

- POST /v1/chat/completions                 OpenAI Chat Completions 兼容
- POST /v1/responses                        OpenAI Responses 兼容
- POST /v1/messages                         Anthropic Messages 兼容
- POST /vertex-ai/…:generateContent         Google Vertex 兼容
- POST /vertex-ai/…:streamGenerateContent   Google Vertex 流式
- POST /v1/images/generations               文生图
- POST /v1/images/edits                     图生图 / 改图(multipart)
- POST /vertex-ai/…:generateImages          Vertex 出图
- POST /vertex-ai/…:editImage               Vertex 改图
- POST /vertex-ai/…:upscaleImage            Vertex 放大
- POST /v1/videos                           异步任务,轮询取结果
- POST /vertex-ai/…:generateVideos          Vertex 视频,异步
- POST /v1/audio/speech                     文本转语音(TTS),返回音频二进制
- GET  /v1/models                           列出你的 key 可调用的模型

## 该示例模型支持的协议

- openai_chat
- openai_responses
- anthropic_messages

## 当前可调用的厂商

- openai
- anthropic
- minimax
- deepseek
- zhipu
- google
- xai

**不在上面这份名单里的厂商现在调不通** —— 公开目录与 `/v1/models` 都会当它不存在,
请不要生成调用它们的代码。名单会随上线进度增加,以 `GET /v1/models` 的实时返回为准。

## 机器可读契约

完整 OpenAPI 3.1 规范(13 个端点、认证、错误信封、计费语义):
https://routemux.com/docs/openapi.json

## 模型清单

- 机器读:`GET https://api.routemux.com/v1/models`(需要 key;返回的就是你实际能调的全集)
- 人读:https://routemux.com/models
- **单个模型的纯文本事实页:在详情页地址后加 `.md`**
  例:https://routemux.com/anthropic/claude-opus-5.md
  含规格表、定价(带单位)、支持的协议、别名与同族变体,不含导航与样式。
  中文版:https://routemux.com/zh/anthropic/claude-opus-5.md

## 计费

- 预付费钱包,按 token 或按次计价,**失败与超时不计费**。
- 一份账单、无月费、无席位费。
- 未使用余额随时可申请退款。
- 用量与账单:https://routemux.com/console/logs 与 https://routemux.com/console/billing

## 出错时

错误体是 OpenAI 兼容形状(`{"error": {...}}`)。
余额不足返回 HTTP **422** `INSUFFICIENT_CREDITS` —— 去 https://routemux.com/console/billing 充值后重试。
限流返回 429 并带 `Retry-After`。
模型侧的三个合成码:`model_not_provisioned`(尚未开通,重试无用)、
`model_busy`(负载已满,**可重试**,带 `Retry-After`)、`model_unavailable`(无法完成)。

## 更多

- 模型目录:https://routemux.com/models
- 关于:https://routemux.com/about
- 条款:https://routemux.com/terms · 隐私:https://routemux.com/privacy