简体中文 | English

介绍

功能	社区版	Pro版
基础功能	✅	✅
用户名、邮箱注册/登录	✅	✅
多用户管理	✅	✅
规则引擎支持（ES5/ES6规范的JS语法引擎自定义规则）	✅	✅
API数据转发核心模块	✅	✅
API令牌	✅	✅
多余额机制	✅	✅
多货币机制（内置两种，Pro支持自定义）	✅	✅
每日签到	✅	✅
多用户等级（内置5层等级）	✅	✅
用户实时RPM、TPM支持	✅	✅
渠道实时RPM、TPM支持	✅	✅
渠道单密钥实时RPM、TPM支持	✅	✅
训练场自定义多外部页面嵌入	✅	✅
远程模型、厂商数据同步	✅	✅
渠道分组支持	✅	✅
渠道分组固定倍率、定时倍率支持	✅	✅
渠道重试	✅	✅
渠道密钥错误禁用（可禁用单密钥、或密钥中本次请求的模型）	✅	✅
渠道密钥错误禁用自动恢复机制	✅	✅
渠道请求熔断超时机制	✅	✅
渠道IP、UA规则限制	✅	✅
渠道全局/独立代理配置，支持HTTP[S]、Socket5协议	✅	✅
兑换码系统	✅	✅
自定义菜单	✅	✅
第三方登录（Github、Gitee、LiunxDO）	✅	✅
安全过滤	✅	✅
API线路展示与测速	✅	✅
API节点状态监控展示	✅	✅
自定义SEO、主题色调与全局样式、脚本等	✅	✅
一键第三方系统数据迁移导入	✅	✅
多优先级计费方式	✅	✅
日志分表（可按照天/周/月/年四个维度进行自动分表）	✅	✅
i18n国际化（已内置中文、英文）	✅	✅
模型多条件计费（阶梯计费）支持，且可按照固定价格和基础倍率两种模式计费	✅	✅
在线支付支持（易支付、Stripe、自助转账等）	❌	✅
自定义多货币支持	❌	✅
自动支付汇率换算、内部换算或支付接口换算	❌	✅
在线自助开票	❌	✅
个人、企业实名认证（支持第三方API和支付宝官方实名认证、手动认证等）	❌	✅
营销通知、群发、异步发送、定时发送等	❌	✅
强大的工单系统	❌	✅
用户可独立的费率、权限定制化	❌	✅
高性能高扩展的动态路由：0s即时热重载，多分组、多上游负载均衡、多路由业务处理器等	❌	✅
邀请好友机制	❌	✅
强大的第三方对象存储转存功能	❌	✅
自定义多前端语言：系统内置CN、EN	❌	✅
在线MCP服务分发支持	❌	✅
不同维度的用户行为、数据模型等数据的可视化分析报告	❌	✅
云端规则市场，各种好玩的模型接入只需要一键接入	❌	✅
除上述之外，Pro还有更多好玩的功能，目前正在小范围内测中，敬请期待～	❌	✅
实际功能不止上述描述，快去体验体验吧～	✅	✅

部署

架构镜像

• Linux amd64: voapi/voapi
• Linux arm64: voapi/voapi-linux-arm64

Docker Compose部署

linux-arm64用户请将docker-compose.yml中的镜像替换为voapi/voapi-linux-arm64

git clone https://github.com/VoAPI/VoAPI.git
cd VoAPI
docker-compose up -d

部署完成后，访问 http://localhost:6800 （请根据实际情况修改域名和端口号）即可进入系统，注册第一个用户即为管理员账号

Docker 单容器部署

请确保您已经准备好了MySQL和Redis数据库，并且正确配置了config.yml文件

linux-arm64用户请将镜像替换为voapi/voapi-linux-arm64

docker run -d --name voapi --restart always -p 6800:6800 -e TZ=Asia/Shanghai -v ./config.yml:/config.yml -v ./file:/file -v ./public:/public voapi/voapi:latest

配置文件

• config.yml

app:
  port: 6800 # 应用监听端口
db:
  dirver: mysql #为空则默认使用mysql，可选mysql,pg
  log-dirver: mysql #为空则默认使用mysql，可选mysql,pg,clickhouse
mysql: #当db.dirver/db.log-dirver为空或mysql时生效
  dsn: root:@tcp(db-voapi:3306)/voapi # 主数据据库
  log-dsn: root:@tcp(db-voapi:3306)/voapi-log # 日志分离数据库
  log-body-dsn: root:@tcp(db-voapi:3306)/voapi-body-log # 请求体日志分离数据库
  log-sharding: # 日志分表方式，支持 day/week/month/year 四种方式
    enable: false
    mode: y # d = day, w = week, m = month, y = year
pg: #当db.dirver/db.log-dirver为pg时生效
  dsn: host=127.0.0.1 port=5432 user=default dbname=voapi # 主数据据库
  log-dsn: host=127.0.0.1 port=5432 user=default dbname=voapi # 日志分离数据库
  log-body-dsn: host=127.0.0.1 port=5432 user=default dbname=voapi # 请求体日志分离数据库
  log-sharding: # 日志分表方式，支持 day/week/month/year 四种方式
    enable: false
    mode: y # d = day, w = week, m = month, y = year
clickhouse: #当db.dirver/db.log-dirver为clickhouse时生效
  log-dsn: clickhouse://default:password@127.0.0.1:9000/voapi?dial_timeout=10s&read_timeout=20s # 日志分离数据库
  log-body-dsn: clickhouse://default:password@127.0.0.1:9000/voapi?dial_timeout=10s&read_timeout=20s # 请求体日志分离数据库
redis:
  dsn: redis://redis-voapi:6379/0
  pool-size: 0 #redis连接池大小，等于0时使用默认值，默认值为CPU数量*100

后台快速配置第一个渠道

• 注册的第一个用户即为管理员账号，登录后点击右上角紫色的齿轮图标进入后台管理界面
• 先到「模型供应商」模块下的「模型列表」、「供应商列表」中点击远程同步，同步官方预置的模型和供应商
• 然后到「模型供应商」模块下的「规则引擎」新建一个空白规则引擎，名称随意，非必填内容无需填写，则为完全透传
• 然后就可以去「渠道管理」-「渠道分组」中新建一个渠道分组
• 最后就可以在「渠道管理」-「渠道列表」中新建一个渠道了，选择刚才新建的规则引擎和渠道分组即可

AI客户端推荐

[!NOTE] 🌻 GoAmzAI支持众多强大的功能：

• 最低1C1G的服务器就能流畅运行
• 宝塔极速可视化部署、配置简单易懂
• 站点完全自适应支持PC、平板、手机
• 低内存占用，Golang开发原生高并发支持
• 包含AI对话、AI绘画、AI音乐、AI视频、AI生成PPT、PDF解析对话、AI应用支持等众多AI模块
• 具有非常完善的运营机制，包括但不限于套餐系统、兑换码系统、邀请奖励、签到福利、推广返利等等
• 🫱 点我立即了解及体验

加群交流

您也可以扫描下方二维码加入QQ交流群以获取最新的开发动态和相关事件

点击链接加入群聊：https://qm.qq.com/q/QFibUxMPEQ

界面截图

PC端

VoAPI 快速上手指南

VoAPI 是一款下一代高颜值、高性能的智能 AI 大模型 API 聚合分发系统，支持多用户管理、多余额/多货币机制、规则引擎及渠道负载均衡等功能。

1. 环境准备

在部署前，请确保您的服务器满足以下要求：

• 操作系统：Linux (推荐 Ubuntu 20.04+ 或 CentOS 7+)
• 架构支持：
  • amd64 (x86_64)
  • arm64 (如鲲鹏、树莓派等)
• 前置依赖：
  • Docker & Docker Compose (推荐使用 Docker Compose 一键部署，自动包含数据库依赖)
  • 若选择单容器部署，需自行准备 MySQL (或 PostgreSQL/ClickHouse) 和 Redis 服务。

2. 安装步骤

推荐使用 Docker Compose 方式进行部署，该方式会自动拉起所需的数据库和缓存服务。

方案 A：Docker Compose 部署（推荐）

此方案适合大多数用户，无需单独配置数据库。

# 1. 克隆项目代码
git clone https://github.com/VoAPI/VoAPI.git
cd VoAPI

# 2. 启动服务
# 注意：如果是 Linux arm64 架构用户，请先编辑 docker-compose.yml，
# 将镜像名称替换为 voapi/voapi-linux-arm64
docker-compose up -d

部署完成后，访问 http://<你的服务器 IP>:6800 即可进入系统。

方案 B：Docker 单容器部署

如果您已有独立的 MySQL 和 Redis 环境，可使用此方案。

1. 准备好 config.yml 配置文件（参考下文配置说明）。
2. 执行以下命令（arm64 用户请将镜像替换为 voapi/voapi-linux-arm64）：

docker run -d --name voapi --restart always \
  -p 6800:6800 \
  -e TZ=Asia/Shanghai \
  -v ./config.yml:/config.yml \
  -v ./file:/file \
  -v ./public:/public \
  voapi/voapi:latest

3. 基本使用

3.1 初始化管理员账号

• 首次访问系统页面时，注册的第一个用户将自动成为管理员账号。
• 登录成功后，点击右上角的紫色齿轮图标即可进入后台管理界面。

3.2 配置第一个 AI 渠道

为了让系统能够转发请求，您需要完成以下核心配置步骤：

1. 同步模型数据：

   • 进入后台 -> 「模型供应商」 -> 「模型列表」或「供应商列表」。
   • 点击 远程同步 按钮，拉取官方预置的模型和供应商数据。

2. 创建规则引擎：

   • 进入 「模型供应商」 -> 「规则引擎」。
   • 新建一个规则引擎，名称随意。若不填写任何规则内容，默认为完全透传模式。

3. 创建渠道分组：

   • 进入 「渠道管理」 -> 「渠道分组」。
   • 新建一个分组（用于归类不同的 API Key）。

4. 添加渠道：

   • 进入 「渠道管理」 -> 「渠道列表」。
   • 新建渠道，填入您的上游 API Key。
   • 关键步骤：在配置中选择刚才创建的 规则引擎 和 渠道分组。

配置完成后，您即可通过 VoAPI 分配的地址和 Token 调用大模型服务了。

3.3 配置文件说明 (可选)

如需修改端口、数据库连接或日志策略，可编辑挂载的 config.yml 文件：

app:
  port: 6800 # 应用监听端口
db:
  dirver: mysql # 数据库驱动：mysql, pg
  log-dirver: mysql # 日志数据库驱动：mysql, pg, clickhouse
mysql:
  dsn: root:@tcp(db-voapi:3306)/voapi # 主数据库连接串
  log-dsn: root:@tcp(db-voapi:3306)/voapi-log # 日志库连接串
redis:
  dsn: redis://redis-voapi:6379/0 # Redis 连接串
  pool-size: 0 # 连接池大小，0 表示默认 (CPU 核数 * 100)

修改配置后需重启容器生效。