本仓库是 CMSG 基于 QuantumNous/new-api 维护的生产定制分支，并在 cliproxyapi/ 中集成 CLIProxyAPI/CPA。
new-api-cmsg 把多种 AI 上游、账号池和协议统一到一个可运营的网关中。除了 upstream New API 提供的用户、令牌、分组、计量和渠道管理能力，CMSG 还维护了额度感知调度、CPA 账号池、Codex/Claude/Gemini/DeepSeek/Kimi 路由与协议适配、渠道能力测试、Codex Radar 和服务端长上下文保护。
本仓库主要解决以下问题：
- 为 Codex、Claude Code、OpenAI SDK 等兼容客户端提供一致的入口；
- 将共享额度、订阅额度和按量余额转化为可解释、可恢复的渠道策略；
- 在 New API 与 CLIProxyAPI 两层保留模型映射、reasoning、工具调用和流式响应语义；
- 让管理员能够定位渠道、账号、网络、配额和协议转换问题；
- 展示渠道测试输出与外部公开评分，帮助管理员比较模型和渠道表现；
- 将源码开发、构建产物和生产运行环境明确分离。
Codex / Claude Code / OpenAI-compatible clients
|
v
New API: auth, groups, metering, billing and routing
|
v
channel guards, quota refresh, aliases and fallback policies
|
+------------+-------------+
| |
v v
CLIProxyAPI / CPA pools Direct provider channels
| |
v v
OpenAI / Claude / Gemini / Kimi DeepSeek / Kimi / others
当前生产入口为 api.cmsg666.xyz，由 cmsg-root 上的公网运行实例提供服务。
| 领域 | 能力 |
|---|---|
| 统一协议入口 | OpenAI Responses、Chat Completions、Claude Messages、Gemini 及常见 OpenAI-compatible 请求 |
| 分组与计量 | 差异化分组、用量计量、订阅制每日额度、共享余额及按量上游的混合展示 |
| 额度感知调度 | 余额刷新、低价优先、高价兜底、渠道自动禁用与恢复、可指定到期时间的临时解除限制、模型别名按真实上游模型结算 |
| CPA 账号池与额度 | Codex/Claude/Kimi/Antigravity 账号池、模型级额度、订阅窗口、重置时间、有效账号去重、冷却与重试 |
| Codex 协议兼容 | DeepSeek 原生 Responses 思考原文续接、跨提供方历史兼容、Kimi 工具适配、自定义与命名空间工具、助手说明与工具结果顺序处理 |
| 稳定性 | 首包前重试、HTTP/2 per-host 连接池、Mihomo 节点故障转移、流式断连清理 |
| Gemini 性能与上下文 | Tool Schema 缓存、请求线性拼装、流式事件转换优化、发送前预算校验、超大工具输出裁剪和明确 token 超限后的有限重试 |
| 渠道能力测试 | 当前灰度支持渠道 1、12、27，可选模型与思考强度，展示测试题、回答、耗时、失败原因和 SVG 动画预览 |
| Codex Radar | 同步四个 Sol/Astra 模型家族的公开评分，展示覆盖题数与成本/耗时统计，提供失败重试、Redis 完整快照和前端自动恢复 |
| 可观测性 | 渠道用量、自定义时间窗口、请求链路、CPA 调度、reasoning effort、流式状态和网络探针 |
| 用户自助 | Codex 桌面端/终端配置说明、上游余额概览、低余额临时额度申请 |
可用模型与分组以运行实例返回的模型列表和渠道配置为准。
管理员可以在渠道页选择模型和思考强度，向指定渠道发起鹈鹕骑自行车 SVG 测试。请求固定到所选渠道，使用其实际配置与模型映射。面板展示题目、回答、请求模型、上游报告模型、耗时和失败原因；SVG 经安全清洗后提供动画预览，结果面板保留到用户主动关闭。
当前测试接口开放渠道 1、12、27，以检测到完整 SVG 作为通过条件。管理员可以直接查看图像和原始回答，比较不同渠道的输出。测试发起实际模型请求并使用上游额度。
仪表盘同步 Codex Radar 的 RadarBench v2 汇总数据，展示 gpt-5.6-sol、gpt-6-sol、gpt-6.1-sol 和 gpt-6-astra。每个模型包括 low、medium、high、xhigh、max、ultra 六档，共 24 个点位。
面板展示公开评分、覆盖题数、API 等价成本与耗时。缺失统计保持未知，采集失败时可以使用 24 小时内的完整缓存，并保留原采集时间与缓存标记；启用 Redis 的实例支持跨重启恢复。详见 雷达数据与失败保护说明。
管理员可结合渠道测试输出和 Radar 评分，评估渠道表现并调整调度配置。
渠道页与仪表盘按美元、人民币和订阅额度百分比展示数据，缺失字段标记为未知。Codex、Kimi 与 Gemini CPA 使用各自的额度采集链路，展示上游提供的订阅窗口和重置时间。Gemini 按独立额度池汇总百分比，并保留各账号的重置时间。详见 Gemini CPA 额度语义。
DeepSeek 原生 Responses 适配保留返回的思考原文，并按用户、令牌、渠道和线程隔离恢复缓存。GPT/Kimi 等跨提供方历史使用独立兼容策略。自定义、动态和命名空间工具在请求与返回流中保持调用标识和客户端名称。详见 DeepSeek 与 Codex 工具续接说明。
CPA 的 Antigravity/Gemini 路径在服务端估算上下文预算，超限时按规则裁剪历史或超大工具输出，并插入截断说明；裁剪会移除部分原文。最终请求仍超过预算则返回明确错误，上游明确报告输入 token 超限时，最多进行一次缩小请求后的重试。详见 长上下文保护说明。
| 用途 | 接口 |
|---|---|
| Responses | POST /v1/responses、POST /v1/responses/compact |
| Chat Completions | POST /v1/chat/completions |
| Claude Messages | POST /v1/messages |
| 模型发现 | GET /v1/models |
| 路径 | 说明 |
|---|---|
controller/、service/、model/ |
New API 请求、业务与数据层 |
relay/、middleware/、setting/ |
协议转换、分发、计费和运行设置 |
web/default/ |
CMSG 唯一维护的 React 前端 |
cliproxyapi/ |
作为 subtree 跟踪的 CLIProxyAPI/CPA 源码 |
ops/ |
余额刷新、渠道守卫、额度控制和观测脚本 |
docs/ |
雷达、额度、上下文保护等功能说明与运行手册 |
docs/proposals/ |
重要架构与上线方案 |
AGENTS.md |
代码、兼容性、分支与生产安全规则 |
DEVELOPMENT.md |
开发、上游同步、构建和部署约定 |
| 分支 | 定位 |
|---|---|
dev/cmsg |
默认分支、日常开发与生产集成源 |
main |
历史服务器基线，仅用于对照 |
feature/*、fix/*、docs/* |
短期工作分支，验证后合回 dev/cmsg |
git clone git@github.com:Yuming12138/newapi-cmsg.git
cd newapi-cmsg
git switch dev/cmsg
git pull --ff-only origin dev/cmsg
git switch -c feature/your-change开始修改前请完整阅读 AGENTS.md 和 DEVELOPMENT.md。常用验证：
go test ./...
(cd web/default && bun run build:check)
(cd cliproxyapi && go test ./...)
(cd cliproxyapi && go build -o test-output ./cmd/server)验证范围应与改动风险相匹配；仅文档变更不需要运行完整构建。
- 当前维护使用本地 Windows 工作副本，CI 或专用构建机也可产出部署文件；
- Windows 可使用
CGO_ENABLED=0 GOOS=linux GOARCH=amd64交叉编译生产二进制，部署前核验版本、目标架构、静态链接与 SHA-256； - 公网节点负责运行服务，接收已验证的不可变产物；源码开发和重型构建在本地或构建机完成；
dev/cmsg是日常集成和生产构建的唯一源分支；- 发布前核验目标实例的 Compose、数据角色和渠道配置；
- API Key、OAuth Token、数据库口令和代理凭据保存在受保护的运行配置中。
详细流程见 DEVELOPMENT.md。
- 使用者必须遵守所接入模型提供商的服务条款以及适用法律法规；
- 部署者需要自行负责访问控制、计费策略、数据保护、审计和上游授权；
- 对外提供生成式 AI 服务前，应确认当地监管、备案和内容安全要求。
- New API upstream：QuantumNous/new-api
- New API 源自：One API
- CLIProxyAPI upstream：router-for-me/CLIProxyAPI
- License：GNU Affero General Public License v3.0
Modified versions that present a user interface must preserve a visible link to the original project: https://github.com/QuantumNous/new-api.
This repository preserves the upstream attribution notice: Frontend design and development by New API contributors.