Docs

MuxLLM 使用文档

从创建 API Key 到 OpenAI、Claude、Gemini、图片与视频调用,这里整理了常用接入方式。模型价格、分组和端点能力请始终以实时模型广场为准。

Quick Start

五步完成首次接入

  1. 注册账号 进入 MuxLLM 控制台创建账号并登录。
  2. 充值余额 按实际使用量充值,余额和消费记录可在控制台查看。
  3. 创建 API Key 为不同客户端、项目或团队场景创建独立令牌。
  4. 选择模型与端点 在模型广场确认模型名称、分组、价格和支持的端点标签。
  5. 测试后接入 先用最小请求验证连接,再把配置用于正式客户端或项目。

Endpoint

接口地址

Base URL 取决于客户端使用的协议。不要同时在客户端和地址中重复填写路径版本。

OpenAI 兼容客户端 https://api.muxllm.com/v1
Claude / Gemini 原生客户端 https://api.muxllm.com
先看端点 模型名称相同不代表支持所有协议。调用前请在模型广场确认目标模型显示的端点标签。

Protocols

如何选择调用端点

模型广场会为每个模型显示一个或多个端点标签。请求路径、认证头和客户端类型都应与标签匹配。

端点标签 常用路径 认证方式 适用场景
openai POST /v1/chat/completions Bearer Token OpenAI 兼容客户端和常规对话调用
openai-response POST /v1/responses Bearer Token 使用 Responses 请求结构的应用
anthropic POST /v1/messages x-api-key Claude 原生 SDK 与 Claude Code 类工具
gemini POST /v1beta/models/{model}:generateContent x-goog-api-key Gemini 原生请求与多模态内容
image-generation POST /v1/images/generations Bearer Token 支持 OpenAI 图片生成结构的模型
openai-video POST /v1/videos Bearer Token 兼容 OpenAI 视频任务结构的模型

路由存在只表示平台能够接收该类请求,不代表每个模型或分组都支持该端点。最终以目标模型的实时端点标签为准。

OpenAI

OpenAI 兼容与 Responses API

OpenAI 兼容客户端通常使用带 /v1 的 Base URL。示例中的 MODEL_NAME 需要替换为模型广场中的精确模型名。

Chat Completions 示例

适用于显示 openai 标签的模型。

POST /v1/chat/completions
curl https://api.muxllm.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [
      {
        "role": "user",
        "content": "你好,请用三句话介绍 MuxLLM。"
      }
    ]
  }'
Responses API 示例

仅选择显示 openai-response 标签的模型。

POST /v1/responses
curl https://api.muxllm.com/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "input": "概括一下统一模型 API 接入的价值。"
  }'

Anthropic

Claude 原生调用

Claude 原生接口使用站点主机地址,不在 Base URL 后额外添加 /v1。目标模型必须显示 anthropic 标签。

Base URLhttps://api.muxllm.com
API Key Headerx-api-key
API Versionanthropic-version: 2023-06-01
Messages API 示例
POST /v1/messages
curl https://api.muxllm.com/v1/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "max_tokens": 1024,
    "messages": [
      {
        "role": "user",
        "content": "你好,请说明这个接口使用的协议。"
      }
    ]
  }'
注意 不要把 OpenAI 客户端的 /v1 Base URL 直接复制到 Claude 原生配置中,否则客户端可能拼接出重复路径。

Gemini

Gemini 原生调用

Gemini 原生请求把模型名放在 URL 路径中。目标模型必须显示 gemini 标签。

Hosthttps://api.muxllm.com
API Key Headerx-goog-api-key
ActiongenerateContent
generateContent 示例
POST /v1beta/models/{model}:generateContent
curl https://api.muxllm.com/v1beta/models/MODEL_NAME:generateContent \
  -H "x-goog-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {
        "role": "user",
        "parts": [
          { "text": "你好,请概括这次请求的内容。" }
        ]
      }
    ]
  }'
安全建议 优先通过 x-goog-api-key 请求头传递 API Key,避免把密钥放入可能被日志记录的 URL 查询参数。

Media

图片与视频模型

图片和视频模型并不共用一种固定协议。先查看模型的端点标签,再选择对应请求结构。

OpenAI 图片生成结构

仅适用于显示 image-generation 标签的模型。尺寸、质量和其他可选参数取决于具体模型。

图片生成示例
POST /v1/images/generations
curl https://api.muxllm.com/v1/images/generations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "prompt": "一张干净、现代的人工智能工作台产品图"
  }'

Gemini 图片模型

如果图片模型只显示 gemini 标签,应使用 Gemini generateContent,不能仅凭“图片模型”名称改用 /v1/images/generations

OpenAI 视频任务结构

显示 openai-video 标签的模型使用异步任务。提交后保存响应中的任务 ID,再查询任务状态。

提交与查询视频任务
POST /v1/videos
curl https://api.muxllm.com/v1/videos \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "model=MODEL_NAME" \
  -F "prompt=雨后的城市街道,镜头缓慢向前移动"
GET /v1/videos/{task_id}
curl https://api.muxllm.com/v1/videos/TASK_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
费用提醒 图片和视频请求可能按次、时长、尺寸或清晰度计费。提交前请先核对模型广场价格,并避免无间隔地重复查询或重复生成。

Clients

常用客户端配置

客户端界面可能随版本变化,但核心字段始终是协议类型、Base URL、API Key 和精确模型名。

01

Cherry Studio

适合使用 OpenAI 兼容接口快速接入对话模型。

  1. 新增自定义供应商,类型选择 OpenAI 或 OpenAI 兼容。
  2. API 地址填写 https://api.muxllm.com/v1
  3. 在 API Key 字段中填写自己的 MuxLLM Key,不要把它保存到截图或公开配置文件。
  4. 手动添加模型广场中的精确模型名,并确认该模型显示 openai 标签。
  5. 执行客户端连接测试;若失败,先检查地址末尾是否重复出现 /v1
02

CC Switch

根据目标工具选择 Claude 原生或 OpenAI 兼容配置,避免混用协议。

目标场景 协议 Base URL 模型端点标签
Claude Code Anthropic 原生 https://api.muxllm.com anthropic
Codex / OpenAI 工具 OpenAI 兼容 https://api.muxllm.com/v1 openaiopenai-response
  1. 为不同工具创建独立供应商配置,便于区分协议、模型和用量。
  2. 选择与目标模型端点标签一致的供应商类型。
  3. 填入对应 Base URL、API Key 和模型名后再启用配置。
  4. 切换完成后先执行低成本文本请求,不要直接发起图片或视频任务。

Troubleshooting

常见错误与排查顺序

同一个状态码可能有多种原因。先查看控制台用量日志和响应错误信息,再按下面的顺序检查。

状态码 常见原因 建议检查
400 请求字段、JSON 或模型参数不符合当前端点要求 请求体格式、必填字段、模型支持的参数
401 API Key 缺失、无效,或认证头与协议不匹配 Bearer、x-api-keyx-goog-api-key
403 账号、分组、模型权限或网络防护限制 账号状态、Key 分组、模型开放范围
404 请求路径错误,或使用了该模型不支持的协议 Base URL、路径版本、模型端点标签
429 请求频率、额度限制或上游暂时繁忙 降低并发、稍后重试、切换可用分组
5xx 请求转换、渠道或上游服务异常 用量日志、模型端点、稍后重试或更换模型
  1. 1
    确认账户

    检查余额、账号状态和 API Key 是否仍然有效。

  2. 2
    确认模型

    模型名必须与模型广场完全一致,包括大小写、连字符和版本号。

  3. 3
    确认协议

    路径、认证头和请求体必须与模型显示的端点标签一致。

  4. 4
    查看日志

    记录请求时间、模型名和错误信息;排查时不要提供完整 API Key。

Billing

账户、余额与 API Key

余额、充值记录和调用消耗在 MuxLLM 控制台中管理。不同模型、分组和媒体规格的价格可能不同,调用前请查看实时模型广场。

按场景拆分 API Key

建议为客户端、项目和团队分别创建 Key,便于查看用量、定位异常和停用单个入口。

只在可信位置保存

将 Key 保存在客户端安全存储、环境变量或服务端密钥管理中,不要放入网页源码和公开仓库。

FAQ

常见问题

为什么模型调用失败?

依次检查 API Key、账户余额、分组权限、模型名称和端点类型。模型广场没有显示的端点,不应默认可用。

Base URL 应该带 /v1 吗?

OpenAI 兼容客户端通常使用 https://api.muxllm.com/v1;Claude 和 Gemini 原生客户端通常使用主机地址 https://api.muxllm.com,再由客户端拼接协议路径。

为什么同一个模型显示多个端点?

这表示平台可以用多种请求协议访问该模型。选择与你的客户端或 SDK 一致的端点即可,不需要同时配置所有协议。

模型价格和数量为什么会变化?

模型、分组、倍率和上游能力会动态调整。静态文档不保存固定数量或价格,请以实时模型广场为准。

API Key 应该如何保存?

请保存在自己的客户端、环境变量或服务端密钥管理中,不要放在公开仓库、网页源码、截图或聊天记录里。

可以给不同工具创建不同 API Key 吗?

可以。建议按客户端、项目和团队场景拆分 API Key,便于观察用量和控制风险。

Start

准备好接入 MuxLLM 了吗?

创建账号后,先在模型广场确认目标模型和端点,再把 API Key 配置到客户端或代码项目中。