BoosAPI/README.md

BoosAPI

AI 聚合网关 + 内置 ComfyUI — 将分散的中转站整合为一个统一入口

把你各处注册的 New API / One API / OneHub / DoneHub / Veloera / AnyRouter / Sub2API 等站点，
汇聚成 一个 API Key、一个入口，自动发现模型、智能路由、成本最优。
内置 ComfyUI 对话助手，自然语言生成图像/视频工作流，开箱即用。
SaaS 多租户架构，组织管理、成员邀请、套餐限制，开箱即用。

中文 | English

---

📖 介绍

现在 AI 生态里出现了越来越多基于 New API / One API 系列的聚合中转站，要管理多个站点的余额、模型列表和 API 密钥，往往既分散又费时。

BoosAPI 作为中转站之上的元聚合层，把多个站点统一到 一个入口——下游所有工具即可无感接入全部模型。

支持的上游范围：

• 聚合面板：New API、One API、OneHub、DoneHub、Veloera、AnyRouter、Sub2API
• 通用兼容接口：OpenAI / Claude / Gemini compatible，cliproxyapi / CPA
• 官方预设：阿里云、智谱、豆包 Coding Plan、DeepSeek、Moonshot、MiniMax、ModelScope
• OAuth 连接：Codex、Claude、Gemini CLI、Antigravity

痛点	BoosAPI 怎么解决
🔑 每个站点一个 Key，下游配置一堆	统一代理入口 + 多下游 Key 策略，模型自动聚合
💸 不知道哪个站点最便宜	智能路由 按成本、余额、使用率选最优通道
🔄 站点挂了手动切换	自动故障转移，失败通道自动冷却并切换
📊 余额分散各处	集中看板 一目了然，余额不足自动告警
✅ 每天签到领额度	自动签到 定时执行，奖励自动追踪
🤷 不知道各站有什么模型	自动模型发现，上游新增模型零配置
🎨 想用 ComfyUI 但不想配工作流	对话助手，自然语言描述即可生成图像/视频
👥 多人协作管理中转站	组织管理，成员邀请，角色权限控制
📋 不同团队需要不同配额	套餐系统，Free/Pro/Enterprise 三级限制

---

✨ 核心功能

🎨 内置 ComfyUI 对话助手

• 自然语言生成工作流：描述你想要的效果，AI 自动构建 ComfyUI 工作流
• 定向视图生成：前/后/左/右 多角度图像生成
• 场景/视频生成：文字描述直接生成视频内容
• SSE 实时流式响应：生成进度实时反馈
• 侧边栏「对话助手」入口，与聚合网关同一界面
• 自动对接 ComfyUI API（:8188），无需额外配置

🌐 统一代理网关

• 兼容 OpenAI 与 Claude 下游格式
• 支持 Responses / Chat Completions / Messages / Completions / Embeddings / Images / Models / Files
• SSE 流式传输，自动格式转换

🧠 智能路由引擎

• 自动发现所有上游站点的可用模型，零配置生成路由表
• 四级成本信号：实测成本 → 配置成本 → 目录参考价 → 默认兜底
• 多通道概率分摊（成本 40% / 余额 30% / 使用率 30%）
• 失败自动冷却（默认 10 分钟），自动切换通道

📡 多平台聚合管理

平台	适配器
New API	new-api
One API	one-api
OneHub	onehub
DoneHub	done-hub
Veloera	veloera
AnyRouter	anyrouter
Sub2API	sub2api

👥 账号与 Token 管理

• 多站点多账号，四级健康状态追踪（healthy / unhealthy / degraded / disabled）
• 凭证加密存储，自动续签，站点联动禁用

✅ 自动签到

• Cron 定时执行（默认每日 08:00）
• 智能解析奖励，签到失败自动通知
• 完整签到日志与并发锁防重

💰 余额管理

• 定时刷新（默认每小时），收入与消费趋势分析
• 余额兜底估算，凭证过期自动重新登录

🔔 告警通知

五种渠道：Webhook / Bark / Server酱 / Telegram Bot / SMTP 邮件

告警场景：余额不足、站点异常、签到失败、代理异常、Token 过期、每日摘要

🎮 模型操练场

• 交互式聊天测试，流式/非流式双模式
• 对比不同通道输出

👥 SaaS 多租户管理

• 组织管理：创建组织，每个组织独立管理成员和配额
• 成员邀请：通过邮件邀请加入组织，支持管理员/成员角色
• 三级套餐：Free（3人）/ Pro（10人）/ Enterprise（100人）
• 权限控制：Owner / Admin / Member 三级角色，细粒度权限
• 套餐限制检查：成员数、API Key 数、日请求量自动限制
• 邀请链接：带 token 的邀请链接，48 小时有效期

🔌 REST API 总览

端点	方法	说明
/api/organizations	GET/POST	组织列表 / 创建组织
/api/organizations/plans	GET	可用套餐列表
/api/organizations/:id	GET/PATCH	组织详情 / 更新
/api/organizations/:id/members	GET	成员列表
/api/organizations/:id/members/:uid	PATCH/DELETE	改角色 / 移除成员
/api/organizations/:id/invitations	GET/POST	邀请列表 / 创建邀请
/api/organizations/:id/invitations/:invId	DELETE	撤销邀请
/api/invitations/:token	GET	公开邀请查询
/api/invitations/:token/accept	POST	接受邀请
/api/users/register	POST	注册新用户
/api/users/login	POST	登录获取 JWT
/api/users/me	GET/PATCH	个人信息 / 更新
/api/user-api-keys	GET/POST	API Key 列表 / 创建

---

🚀 快速开始

Docker Compose（推荐）

mkdir boosapi && cd boosapi

cat > docker-compose.yml << 'EOF'
services:
  boosapi:
    image: 1467078763/metapi:latest
    ports:
      - "4000:4000"
    volumes:
      - ./data:/app/data
    environment:
      AUTH_TOKEN: ${AUTH_TOKEN:?AUTH_TOKEN is required}
      PROXY_TOKEN: ${PROXY_TOKEN:?PROXY_TOKEN is required}
      CHECKIN_CRON: "0 8 * * *"
      BALANCE_REFRESH_CRON: "0 * * * *"
      PORT: ${PORT:-4000}
      DATA_DIR: /app/data
      TZ: ${TZ:-Asia/Shanghai}
    restart: unless-stopped
EOF

# AUTH_TOKEN = 管理后台登录令牌
# PROXY_TOKEN = 下游客户端调用 /v1/* 的 Token
export AUTH_TOKEN=your-admin-token
export PROXY_TOKEN=your-proxy-sk-token
docker compose up -d

启动后访问 http://localhost:4000，用 AUTH_TOKEN 登录即可。

Important

请务必修改 AUTH_TOKEN 和 PROXY_TOKEN，不要使用默认值。

---

🏗️ 技术栈

层	技术
后端框架	Fastify
前端框架	React 18 + Vite
语言	TypeScript
样式	Tailwind CSS v4
数据库	SQLite / MySQL / PostgreSQL + Drizzle ORM
数据可视化	VChart
定时任务	node-cron
容器化	Docker + Docker Compose
测试	Vitest

---

🛠️ 本地开发

npm install
npm run db:migrate
npm run dev       # 前后端热更新

npm run build           # 构建前端 + 后端
npm run build:web       # 仅构建前端
npm run build:server    # 仅构建后端
npm test                # 运行全部测试
npm run db:generate     # 生成迁移文件

---

📜 License

MIT