API 文档

OpenMux 兼容 OpenAI 格式 — 只需替换 base URL，即可接入任何现有应用。

认证

在请求头中传入 API Key： Authorization

http

Authorization: Bearer om-sk-your-key

Base URL

将当前服务商的 base URL 替换为：

text

https://api.openmux.ai/v1

快速开始

兼容官方 openai SDK:

python

from openai import OpenAI

client = OpenAI(
    base_url="https://api.openmux.ai/v1",
    api_key="om-sk-your-key",
)

response = client.chat.completions.create(
    model="claude-sonnet-4-6",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(response.choices[0].message.content)

typescript

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.openmux.ai/v1",
  apiKey: "om-sk-your-key",
});

const response = await client.chat.completions.create({
  model: "claude-sonnet-4-6",
  messages: [{ role: "user", content: "Hello!" }],
  stream: true,
});

for await (const chunk of response) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}

Claude Code / Cursor 接入

设置以下环境变量：

bash

# Claude Code
export ANTHROPIC_BASE_URL="https://api.openmux.ai"
export ANTHROPIC_API_KEY="om-sk-your-key"
claude

# Cursor — Settings > Models > OpenAI API Key
# Base URL: https://api.openmux.ai/v1
# API Key:  om-sk-your-key

Chat Completions

bash

curl https://api.openmux.ai/v1/chat/completions \
  -H "Authorization: Bearer om-sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "messages": [{"role": "user", "content": "Hello!"}],
    "stream": true
  }'

Anthropic 原生格式

/v1/messages 端点同样支持：

bash

curl https://api.openmux.ai/v1/messages \
  -H "x-api-key: om-sk-your-key" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-sonnet-4-6",
    "max_tokens": 1024,
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

支持的模型

完整列表及定价见模型页面

text

Claude:  claude-opus-4-5 · claude-sonnet-4-6 · claude-haiku-4-5-20251001
OpenAI:  gpt-4o · gpt-4o-mini
Google:  gemini-2.0-flash · gemini-2.5-pro
DeepSeek: deepseek-chat · deepseek-reasoner

错误码

401API Key 无效或缺失

402余额不足 — 请充值

404模型未找到或未激活

429请求频率超限 — 每个 Key 每分钟 60 次

500上游错误 — 我们会转发服务商的错误信息

使用 Cloudflare 自托管

如果你自己部署 OpenMux，可以用 Cloudflare 隐藏服务器 IP 并免费获得 HTTPS。

1 · DNS

添加 A 记录，将 api.yourdomain.com 指向服务器 IP，并开启橙色云代理。

2 · SSL/TLS

在 Cloudflare → SSL/TLS → 概述中，将模式设为 Flexible （Cloudflare 处理 HTTPS，转发 HTTP 到服务器）。

3 · 端口转发（Origin Rule）

如果服务器监听非标准端口（如 10086），创建 Origin Rule：

text

Rules → Origin Rules → Create Rule
Hostname: api.yourdomain.com
Destination Port → Rewrite to: 10086