Pure 博客

API 调用示例

示例默认使用环境变量：

export OMG_API_KEY="sk-你的API令牌"
export OMG_BASE_URL="https://api.omgrouter.cc"

获取模型列表

curl "$OMG_BASE_URL/v1/models" \
  -H "Authorization: Bearer $OMG_API_KEY"

Chat Completions

适合 OpenAI 兼容聊天接口。

curl "$OMG_BASE_URL/v1/chat/completions" \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      { "role": "system", "content": "你是一个简洁的助手。" },
      { "role": "user", "content": "只回复 OK" }
    ],
    "max_tokens": 8
  }'

文本读取位置：

choices[0].message.content

Responses API

适合 GPT 系列新项目和 Codex 类客户端。

curl "$OMG_BASE_URL/v1/responses" \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "instructions": "你是一个简洁的助手。",
    "input": "只回复 OK",
    "max_output_tokens": 8
  }'

当前服务端可能不会填充 output_text 快捷字段，建议使用兼容读取方式：

function getResponseText(response) {
  if (typeof response.output_text === "string" && response.output_text) {
    return response.output_text;
  }

  return (response.output || [])
    .flatMap((item) => item.content || [])
    .filter((part) => part.type === "output_text" && part.text)
    .map((part) => part.text)
    .join("");
}

Python 标准库示例

无需安装 SDK，适合排查网络和鉴权问题。

import json
import os
import urllib.request

api_key = os.environ["OMG_API_KEY"]
base_url = os.environ.get("OMG_BASE_URL", "https://api.omgrouter.cc")

payload = {
    "model": "gpt-5.4-mini",
    "messages": [{"role": "user", "content": "只回复 OK"}],
    "max_tokens": 8,
}

request = urllib.request.Request(
    f"{base_url}/v1/chat/completions",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json",
    },
    method="POST",
)

with urllib.request.urlopen(request, timeout=60) as response:
    data = json.loads(response.read().decode("utf-8"))

print(data["choices"][0]["message"]["content"])

Node 原生 fetch 示例

Node.js 18+ 可直接运行。

const apiKey = process.env.OMG_API_KEY;
const baseUrl = process.env.OMG_BASE_URL || "https://api.omgrouter.cc";

const response = await fetch(`${baseUrl}/v1/chat/completions`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    model: "gpt-5.4-mini",
    messages: [{ role: "user", content: "只回复 OK" }],
    max_tokens: 8,
  }),
});

if (!response.ok) {
  throw new Error(`${response.status} ${await response.text()}`);
}

const data = await response.json();
console.log(data.choices[0].message.content);

OpenAI Python SDK

pip install openai

from openai import OpenAI

client = OpenAI(
    api_key="sk-你的API令牌",
    base_url="https://api.omgrouter.cc/v1",
)

response = client.chat.completions.create(
    model="gpt-5.4-mini",
    messages=[{"role": "user", "content": "只回复 OK"}],
    max_tokens=8,
)

print(response.choices[0].message.content)

OpenAI Node SDK

npm install openai

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.OMG_API_KEY,
  baseURL: "https://api.omgrouter.cc/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.4-mini",
  messages: [{ role: "user", content: "只回复 OK" }],
  max_tokens: 8,
});

console.log(response.choices[0].message.content);

Claude Messages

适合 Claude 官方协议。令牌分组请使用 CC 或 CC-N，具体见模型分组。

curl "$OMG_BASE_URL/v1/messages" \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -H "anthropic-version: 2023-06-01" \
  -d '{
    "model": "claude-sonnet-4.5",
    "max_tokens": 64,
    "messages": [
      { "role": "user", "content": "只回复 OK" }
    ]
  }'

Embeddings

curl "$OMG_BASE_URL/v1/embeddings" \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "OMG Router 文档测试"
  }'

Gemini 兼容生成

curl "$OMG_BASE_URL/v1beta/models/gemini-2.5-flash:generateContent" \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      {
        "role": "user",
        "parts": [{ "text": "只回复 OK" }]
      }
    ]
  }'

如果返回模型不存在，请先在控制台确认当前令牌分组是否包含该 Gemini 模型。

账户令牌用量

令牌维度的用量接口：

curl "$OMG_BASE_URL/api/usage/token/" \
  -H "Authorization: Bearer $OMG_API_KEY"

该接口会返回令牌名称、已用额度、剩余额度、模型限制、过期时间等信息。

客户端接入

不同客户端对 Base URL 的要求不同。最常见的规则是：

OpenAI SDK / Codex：填写 https://api.omgrouter.cc/v1
Claude Code / Anthropic 协议：填写 https://api.omgrouter.cc
Cherry Studio 的 New API/OpenAI 兼容提供商：填写 https://api.omgrouter.cc
CC Switch 导入 Codex 时 endpoint 自动使用 /v1，导入 Claude/Gemini 时不带 /v1

Codex CLI

安装：

npm install -g @openai/codex@latest

配置目录：

| 系统 | 路径 | | --- | --- | | macOS / Linux | ~/.codex | | Windows | %USERPROFILE%\.codex |

~/.codex/config.toml：

model_provider = "omgrouter"
model = "gpt-5.4-mini"
model_reasoning_effort = "medium"

[model_providers.omgrouter]
name = "OMG Router"
base_url = "https://api.omgrouter.cc/v1"
wire_api = "responses"
requires_openai_auth = true
web_search = "live"

~/.codex/auth.json：

{
  "OPENAI_API_KEY": "sk-你的API令牌"
}

启动验证：

codex

如果提示模型不可用，请确认 API Key 是 Codex 分组，并且 model 在控制台模型广场可见。

Claude Code

安装：

npm install -g @anthropic-ai/claude-code@latest

推荐使用环境变量：

macOS / Linux：

export ANTHROPIC_BASE_URL="https://api.omgrouter.cc"
export ANTHROPIC_AUTH_TOKEN="sk-你的API令牌"
claude

Windows PowerShell：

[Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "https://api.omgrouter.cc", "User")
[Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", "sk-你的API令牌", "User")
claude

Claude Code 请使用 CC 分组令牌。第三方客户端调用 Claude 时使用 CC-N 分组。

CC Switch

控制台令牌列表里可以打开「导入到 CC Switch」对话框，选择应用、模型和名称后导入。

导入规则：

| 应用 | endpoint | | --- | --- | | Codex | https://api.omgrouter.cc/v1 | | Claude | https://api.omgrouter.cc | | Gemini | https://api.omgrouter.cc |

手动导入 URL 示例：

ccswitch://v1/import?resource=provider&app=codex&name=OMG%20Codex&endpoint=https%3A%2F%2Fapi.omgrouter.cc%2Fv1&apiKey=sk-你的API令牌&model=gpt-5.4-mini&homepage=https%3A%2F%2Fapi.omgrouter.cc&enabled=true

打开 https://api.omgrouter.cc/ccswitch 返回的是前端页面。真正导入动作依赖本机 ccswitch:// 协议是否已由 CC Switch 注册。

Cherry Studio

手动配置：

| 字段 | 值 | | --- | --- | | Provider 类型 | OpenAI Compatible / New API | | API Key | sk-你的API令牌 | | Base URL | https://api.omgrouter.cc | | Models | 从 /v1/models 或控制台模型广场选择 |

一键导入协议是：

cherrystudio://providers/api-keys?v=1&data=<URL编码后的base64配置>

配置 payload 结构：

{
  "id": "new-api",
  "name": "OMG Router",
  "type": "new-api",
  "baseUrl": "https://api.omgrouter.cc",
  "apiKey": "sk-你的API令牌"
}

生成导入链接：

const payload = {
  id: "new-api",
  name: "OMG Router",
  type: "new-api",
  baseUrl: "https://api.omgrouter.cc",
  apiKey: process.env.OMG_API_KEY,
};

const data = encodeURIComponent(
  Buffer.from(JSON.stringify(payload), "utf8").toString("base64")
);

console.log(`cherrystudio://providers/api-keys?v=1&data=${data}`);

如果浏览器没有弹出 Cherry Studio，请先确认 Cherry Studio 已安装并注册 cherrystudio:// 协议。

OpenCode

OpenCode 使用 OpenAI 兼容配置时：

export OPENAI_API_KEY="sk-你的API令牌"
export OPENAI_BASE_URL="https://api.omgrouter.cc/v1"
opencode

如果 OpenCode 使用配置文件，请将 provider 的 base URL 指向：

https://api.omgrouter.cc/v1

模型建议选择 Codex 分组中可见的代码模型。

模型分组

OMG Router 的 API Key 会绑定分组。分组决定可用模型、计费倍率和适用工具。遇到「模型不存在」「无可用渠道」「Claude Code 能用但第三方不能用」等问题时，优先检查分组。

快速选择表

| 使用场景 | 推荐分组 | 协议 | | --- | --- | --- | | 普通 OpenAI 兼容客户端、自己的程序 | 默认分组 | Chat Completions / Responses | | GPT 系列新项目 | 默认分组 | Responses API | | Claude Code CLI | CC 分组 | Claude 官方协议 | | 第三方客户端调用 Claude | CC-N 分组 | Claude 官方协议 /v1/messages | | Codex CLI / Codex App / 代码编辑器 | Codex 分组 | Responses API | | Gemini CLI 或 Gemini 兼容请求 | 对应 Gemini 可用分组 | Gemini / OpenAI 兼容，按控制台说明 |

默认分组

适合自己的程序、OpenAI 兼容 SDK、Cherry Studio、Open WebUI 等第三方客户端。

常用端点：

GET /v1/models
POST /v1/chat/completions
POST /v1/responses
POST /v1/embeddings
POST /v1/images/generations

Claude 模型不要强行用 Chat Completions 调用。Claude 系列应使用 Claude 官方 Messages 协议。

CC 分组

适合 Claude Code 官方 CLI 和相关插件。

特点：

面向 Claude Code 优化。
通常不建议接入普通第三方客户端。
Base URL 通常填写 https://api.omgrouter.cc。
API Key 写入 ANTHROPIC_AUTH_TOKEN 或客户端对应的 Anthropic Key 字段。

CC-N 分组

适合在第三方客户端或自己的代码里调用 Claude。

特点：

使用 Claude 官方 Messages 协议：POST /v1/messages。
需要客户端支持 Anthropic/Claude 格式。
不要用 OpenAI Chat Completions 格式调用 Claude。

Codex 分组

适合 Codex CLI、Codex App、OpenCode、Cursor/Cline 等代码工具。

特点：

Base URL 使用 https://api.omgrouter.cc/v1。
Codex 配置里 wire_api 建议使用 responses。
模型以控制台「模型广场」实时列表为准，例如 gpt-5.4、gpt-5.4-mini、codex-auto-review 等。

查看实时模型

登录控制台后查看「模型广场」或价格页：

https://api.omgrouter.cc/pricing

也可以通过 API 查询当前令牌可见模型：

curl https://api.omgrouter.cc/v1/models \
  -H "Authorization: Bearer $OMG_API_KEY"

快速开始

本页从账号、额度、API Key 到第一次接口调用，带你完成最小可用接入。

1. 注册并登录

访问控制台：

https://api.omgrouter.cc

完成邮箱注册后登录控制台。建议使用强密码，并妥善保存登录凭证。

2. 充值额度

登录后进入「钱包管理」或「充值」页面，根据控制台当前支持的支付方式充值。额度到账后即可用于 API 调用。

实际扣费会受模型价格、分组倍率、输入输出 token 数、图片/视频任务价格等因素影响。价格和可用模型以控制台「模型广场」/「价格」页面为准：

https://api.omgrouter.cc/pricing

3. 创建 API Key

进入「令牌管理」页面创建令牌。

建议填写：

| 字段 | 建议 | | --- | --- | | 令牌名称 | 按用途命名，例如 local-test、production、codex | | 令牌分组 | 根据工具选择，见模型分组 | | 过期时间 | 生产环境建议设置合理过期时间 | | 额度限制 | 给测试环境设置额度上限，避免误用 | | 模型限制 | 只开放当前业务需要的模型 |

复制令牌后请立即保存。文档和代码中统一用环境变量承载：

export OMG_API_KEY="sk-你的API令牌"

Windows PowerShell：

$env:OMG_API_KEY = "sk-你的API令牌"

4. 查询可用模型

curl https://api.omgrouter.cc/v1/models \
  -H "Authorization: Bearer $OMG_API_KEY"

返回示例：

{
  "object": "list",
  "data": [
    {
      "id": "gpt-5.4-mini",
      "object": "model"
    }
  ]
}

如果模型列表为空或缺少目标模型，通常是令牌分组不匹配，或该模型未对当前账号/分组开放。

5. 第一次聊天调用

curl https://api.omgrouter.cc/v1/chat/completions \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      { "role": "user", "content": "只回复 OK" }
    ],
    "max_tokens": 8
  }'

响应中的文本位置：

choices[0].message.content

6. 选择正确协议

| 场景 | 推荐端点 | Base URL | | --- | --- | --- | | GPT / OpenAI 兼容聊天 | POST /v1/chat/completions 或 POST /v1/responses | https://api.omgrouter.cc/v1 | | Claude 官方协议 | POST /v1/messages | https://api.omgrouter.cc | | Gemini 兼容接口 | POST /v1beta/models/{model}:generateContent | https://api.omgrouter.cc | | Codex CLI | Responses API | https://api.omgrouter.cc/v1 | | Cherry Studio OpenAI 兼容 | OpenAI Compatible / New API | https://api.omgrouter.cc |

注意：是否在 Base URL 里带 /v1 取决于客户端。OpenAI SDK 通常填写 https://api.omgrouter.cc/v1；Claude、Gemini、部分第三方客户端会自己拼接路径，通常填写 https://api.omgrouter.cc。

OMG Router 文档

OMG Router 是一个统一的 AI API 中转入口，面向 OpenAI 兼容接口、Claude 官方协议、Gemini 兼容接口，以及 Codex、Claude Code、Cherry Studio、CC Switch 等工具接入场景。

常用地址

| 用途 | 地址 | | --- | --- | | 控制台 | https://api.omgrouter.cc | | API Base URL | https://api.omgrouter.cc/v1 | | OpenAI 兼容模型列表 | GET https://api.omgrouter.cc/v1/models | | 价格与模型广场 | https://api.omgrouter.cc/pricing | | CC Switch 页面 | https://api.omgrouter.cc/ccswitch |

文档目录

| 页面 | 内容 | | --- | --- | | 快速开始 | 注册、充值、创建 API Key、第一次调用 | | API 调用示例 | curl、Python、Node、OpenAI SDK、Claude、Gemini、嵌入 | | 模型分组 | 默认、CC、CC-N、Codex 分组选择规则 | | 客户端接入 | Codex、Claude Code、CC Switch、Cherry Studio、OpenCode | | 排障指南 | 401、模型不存在、协议不匹配、跳转失败、余额问题 | | 验证记录 | 本次文档示例的实际调试结果 |

最小可用调用

export OMG_API_KEY="sk-你的API令牌"

curl https://api.omgrouter.cc/v1/chat/completions \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [
      { "role": "user", "content": "只回复 OK" }
    ],
    "max_tokens": 8
  }'

成功时会返回 OpenAI Chat Completions 兼容格式，正文在 choices[0].message.content。

安全提醒

不要把真实 API Key 写进公开文档、截图、Git 仓库或前端代码。
文档示例统一使用 sk-你的API令牌、$OMG_API_KEY 占位。
如果 API Key 曾经泄露，请在控制台删除旧令牌并重新创建。

排障指南

快速自检

先运行：

curl https://api.omgrouter.cc/v1/models \
  -H "Authorization: Bearer $OMG_API_KEY"

如果模型列表正常，再测试：

curl https://api.omgrouter.cc/v1/chat/completions \
  -H "Authorization: Bearer $OMG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4-mini",
    "messages": [{ "role": "user", "content": "只回复 OK" }],
    "max_tokens": 8
  }'

401 / Invalid Bearer token

原因通常是：

没有传 Authorization: Bearer sk-...
API Key 多了空格、换行或引号。
令牌已删除、禁用或过期。
把登录 token 当成 API Key 使用。

解决：

echo "$OMG_API_KEY" | sed 's/./*/g'

确认环境变量非空后，重新复制控制台中的 sk- 令牌。

模型不存在

常见原因：

令牌分组不对。
模型名写错。
目标模型已调整名称或暂时下线。
Claude 模型用错了 OpenAI Chat Completions 协议。

解决：

访问 https://api.omgrouter.cc/pricing 查看实时模型。
用当前令牌调用 /v1/models。
按模型分组切换到正确分组。

Claude Code 不能用

检查项：

API Key 是否为 CC 分组。
ANTHROPIC_BASE_URL 是否为 https://api.omgrouter.cc，不要写成 /v1。
ANTHROPIC_AUTH_TOKEN 是否为 sk- 开头的令牌。
终端是否重新打开，环境变量是否生效。

Codex 不能用

检查项：

API Key 是否为 Codex 分组。
base_url 是否为 https://api.omgrouter.cc/v1。
wire_api 是否为 responses。
model 是否在当前令牌的 /v1/models 返回列表中。

Cherry Studio 跳转不成功

cherrystudio://... 是本机自定义协议，浏览器必须交给 Cherry Studio 处理。排查顺序：

确认 Cherry Studio 已安装。
在系统里确认 cherrystudio:// 协议已注册。
换浏览器打开导入链接，部分浏览器会拦截外部应用跳转。
检查 payload 是否是 encodeURIComponent(base64(JSON))。
payload 的 baseUrl 填 https://api.omgrouter.cc，不要手动追加 /v1。
payload 的 apiKey 必须是完整 sk-...。

生成链接时建议用代码，不要手工拼 base64：

const payload = {
  id: "new-api",
  name: "OMG Router",
  type: "new-api",
  baseUrl: "https://api.omgrouter.cc",
  apiKey: "sk-你的API令牌",
};

const data = encodeURIComponent(
  Buffer.from(JSON.stringify(payload), "utf8").toString("base64")
);

console.log(`cherrystudio://providers/api-keys?v=1&data=${data}`);

CC Switch 跳转不成功

https://api.omgrouter.cc/ccswitch 是网页入口，真正导入依赖 ccswitch:// 协议。

排查顺序：

确认 CC Switch 已安装。
确认系统已注册 ccswitch:// 协议。
用控制台里的「导入到 CC Switch」按钮生成链接。
Codex endpoint 应带 /v1，Claude/Gemini endpoint 不带 /v1。
换浏览器或允许浏览器打开外部应用。

Responses API 返回了 200 但拿不到文字

当前服务端可能不会填充 output_text 快捷字段。优先从 output 数组提取：

const text = (response.output || [])
  .flatMap((item) => item.content || [])
  .filter((part) => part.type === "output_text")
  .map((part) => part.text)
  .join("");

余额不足或额度限制

检查：

账户余额是否充足。
令牌是否设置了额度上限。
模型价格或分组倍率是否较高。
是否有长上下文或流式任务造成消耗增加。

可查询令牌用量：

curl https://api.omgrouter.cc/api/usage/token/ \
  -H "Authorization: Bearer $OMG_API_KEY"

验证记录

验证时间：2026-06-05

验证环境：

| 项目 | 结果 | | --- | --- | | 本地服务 | new-api 容器运行中，健康状态正常 | | 本地 API | http://127.0.0.1:3000 | | 公网 API | https://api.omgrouter.cc | | Node.js | v24.16.0 | | Python | 3.12.3 | | npm | 11.13.0 |

已验证项目

| 项目 | 命令/接口 | 结果 | | --- | --- | --- | | 服务状态 | GET /api/status | HTTP 200 | | 公网首页 | GET https://api.omgrouter.cc/ | HTTP 200 | | CC Switch 页面 | GET https://api.omgrouter.cc/ccswitch | HTTP 200，返回前端 HTML | | 模型列表 | GET /v1/models | HTTP 200，返回模型列表 | | Chat Completions | POST /v1/chat/completions | HTTP 200，返回 OK | | Responses API | POST /v1/responses | HTTP 200，文本位于 output[0].content[0].text |

当前测试观察

/v1/models 当前可见模型包括：

codex-auto-review
gpt-5.4
gpt-5.4-2026-03-05
gpt-5.4-mini
gpt-5.4-openai-compact
gpt-5.5
gpt-5.5-openai-compact

Chat Completions 测试请求：

{
  "model": "gpt-5.4-mini",
  "messages": [
    { "role": "user", "content": "只回复 OK" }
  ],
  "max_tokens": 8
}

返回重点：

{
  "object": "chat.completion",
  "model": "gpt-5.4-mini-2026-03-17",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "OK"
      },
      "finish_reason": "stop"
    }
  ]
}

Responses API 测试请求：

{
  "model": "gpt-5.4-mini",
  "input": "只回复 OK",
  "max_output_tokens": 8
}

返回重点：

{
  "object": "response",
  "status": "completed",
  "model": "gpt-5.4-mini-2026-03-17",
  "output": [
    {
      "type": "message",
      "content": [
        {
          "type": "output_text",
          "text": "OK"
        }
      ]
    }
  ]
}

因此文档中的 Responses 示例采用兼容提取逻辑，而不是只读取 output_text。

未执行真实调用的项目

以下项目已按服务端 OpenAPI 和前端生成逻辑编写，但本次没有消耗真实任务额度做完整生成：

Claude /v1/messages
Gemini /v1beta/models/{model}:generateContent
图片生成 /v1/images/generations
视频生成 /v1/videos
音频转录/语音合成

这些接口的可用性还取决于令牌分组、账号额度、具体模型是否在控制台开放。