main
NOTE
本项目为开源项目，在 One API 的基础上进行二次开发，由必创API团队维护
IMPORTANT
- 本项目仅供个人学习使用，不保证稳定性，且不提供任何技术支持
- 使用者必须在遵循 OpenAI 的 使用条款 以及法律法规的情况下使用，不得用于非法用途
- 根据 《生成式人工智能服务管理暂行办法》 的要求，请勿对中国地区公众提供一切未经备案的生成式人工智能服务
排名不分先后
感谢 JetBrains 为本项目提供免费的开源开发许可证
# 克隆项目
git clone https://gitee.com/buidai/buidapi.git
cd buidapi
# 编辑 docker-compose.yml 配置
nano docker-compose.yml
# 启动服务
docker-compose up -d
使用 Docker 命令
# 拉取最新镜像
docker pull buidapi/buidai-api:latest
# 使用 SQLite（默认）
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-api:latest
# 使用 MySQL
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-api:latest
💡 提示：
-v ./data:/data会将数据保存在当前目录的data文件夹中，你也可以改为绝对路径如-v /your/custom/path:/data
🎉 部署完成后，访问 http://localhost:3000 即可使用！
📖 更多部署方式请参考 部署指南
📖 官方文档 | 
快速导航：
| 分类 | 链接 |
|---|---|
| 🚀 部署指南 | 安装文档 |
| ⚙️ 环境配置 | 环境变量 |
| 📡 接口文档 | API 文档 |
| ❓ 常见问题 | FAQ |
| 💬 社区交流 | 交流渠道 |
详细特性请参考 特性说明
| 特性 | 说明 |
|---|---|
| 🎨 全新 UI | 现代化的用户界面设计 |
| 🌍 多语言 | 支持中文、英文、法语、日语 |
| 🔄 数据兼容 | 完全兼容原版 One API 数据库 |
| 📈 数据看板 | 可视化控制台与统计分析 |
| 🔒 权限管理 | 令牌分组、模型限制、用户管理 |
- ✅ 在线充值（易支付、Stripe）
- ✅ 模型按次数收费
- ✅ 缓存计费支持（OpenAI、Azure、DeepSeek、Claude、Qwen等所有支持的模型）
- ✅ 灵活的计费策略配置
- 😈 Discord 授权登录
- 🤖 LinuxDO 授权登录
- 📱 Telegram 授权登录
- 🔑 OIDC 统一认证
- 🔍 Key 查询使用额度（配合 neko-api-key-tool）
API 格式支持：
- ⚡ OpenAI Responses
- ⚡ OpenAI Realtime API（含 Azure）
- ⚡ Claude Messages
- ⚡ Google Gemini
- 🔄 Rerank 模型（Cohere、Jina）
智能路由：
- ⚖️ 渠道加权随机
- 🔄 失败自动重试
- 🚦 用户级别模型限流
格式转换：
- 🔄 OpenAI Compatible ⇄ Claude Messages
- 🔄 OpenAI Compatible → Google Gemini
- 🔄 Google Gemini → OpenAI Compatible - 仅支持文本，暂不支持函数调用
- 🚧 OpenAI Compatible ⇄ OpenAI Responses - 开发中
- 🔄 思考转内容功能
Reasoning Effort 支持：
查看详细配置
OpenAI 系列模型：
o3-mini-high- High reasoning efforto3-mini-medium- Medium reasoning efforto3-mini-low- Low reasoning effortgpt-5-high- High reasoning effortgpt-5-medium- Medium reasoning effortgpt-5-low- Low reasoning effort
Claude 思考模型：
claude-3-7-sonnet-20250219-thinking- 启用思考模式
Google Gemini 系列模型：
gemini-2.5-flash-thinking- 启用思考模式gemini-2.5-flash-nothinking- 禁用思考模式gemini-2.5-pro-thinking- 启用思考模式gemini-2.5-pro-thinking-128- 启用思考模式，并设置思考预算为128tokens- 也可以直接在 Gemini 模型名称后追加
-low/-medium/-high来控制思考力度（无需再设置思考预算后缀）
详情请参考 接口文档 - 中继接口
| 模型类型 | 说明 | 文档 |
|---|---|---|
| 🤖 OpenAI GPTs | gpt-4-gizmo-* 系列 | - |
| 🎨 Midjourney-Proxy | Midjourney-Proxy(Plus) | 文档 |
| 🎵 Suno-API | Suno API | 文档 |
| 🔄 Rerank | Cohere、Jina | 文档 |
| 💬 Claude | Messages 格式 | 文档 |
| 🌐 Gemini | Google Gemini 格式 | 文档 |
| 🔧 Dify | ChatFlow 模式 | - |
| 🎯 自定义 | 支持完整调用地址 | - |
查看完整接口列表
TIP
最新版 Docker 镜像： buidapi/buidai-api:latest
| 组件 | 要求 |
|---|---|
| 本地数据库 | SQLite（Docker 需挂载 /data 目录） |
| 远程数据库 | MySQL ≥ 5.7.8 或 PostgreSQL ≥ 9.6 |
| 容器引擎 | Docker / Docker Compose |
常用环境变量配置
| 变量名 | 说明 | 默认值 |
|---|---|---|
SESSION_SECRET | 会话密钥（多机部署必须） | - |
CRYPTO_SECRET | 加密密钥（Redis 必须） | - |
SQL_DSN | 数据库连接字符串 | - |
REDIS_CONN_STRING | Redis 连接字符串 | - |
STREAMING_TIMEOUT | 流式超时时间（秒） | 300 |
STREAM_SCANNER_MAX_BUFFER_MB | 流式扫描器单行最大缓冲（MB），图像生成等超大 data: 片段（如 4K 图片 base64）需适当调大 | 64 |
MAX_REQUEST_BODY_MB | 请求体最大大小（MB，解压后计；防止超大请求/zip bomb 导致内存暴涨），超过将返回 413 | 32 |
AZURE_DEFAULT_API_VERSION | Azure API 版本 | 2025-04-01-preview |
ERROR_LOG_ENABLED | 错误日志开关 | false |
PYROSCOPE_URL | Pyroscope 服务地址 | - |
PYROSCOPE_APP_NAME | Pyroscope 应用名 | new-api |
PYROSCOPE_BASIC_AUTH_USER | Pyroscope Basic Auth 用户名 | - |
PYROSCOPE_BASIC_AUTH_PASSWORD | Pyroscope Basic Auth 密码 | - |
PYROSCOPE_MUTEX_RATE | Pyroscope mutex 采样率 | 5 |
PYROSCOPE_BLOCK_RATE | Pyroscope block 采样率 | 5 |
HOSTNAME | Pyroscope 标签里的主机名 | new-api |
📖 完整配置： 环境变量文档
方式 1：Docker Compose（推荐）
# 克隆项目
git clone https://gitee.com/buidai/buidapi.git
cd buidapi
# 编辑配置
nano docker-compose.yml
# 启动服务
docker-compose up -d
方式 2：Docker 命令
使用 SQLite：
docker run --name buidai-api -d --restart always \ -p 3000:3000 \ -e TZ=Asia/Shanghai \ -v ./data:/data \ buidapi/buidai-api:latest
使用 MySQL：
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-api:latest
💡 路径说明：
./data:/data- 相对路径，数据保存在当前目录的 data 文件夹- 也可使用绝对路径，如：
/your/custom/path:/data
WARNING
- 必须设置
SESSION_SECRET- 否则登录状态不一致 - 公用 Redis 必须设置
CRYPTO_SECRET- 否则数据无法解密
重试配置： 设置 → 运营设置 → 通用设置 → 失败重试次数
缓存配置：
REDIS_CONN_STRING：Redis 缓存（推荐）MEMORY_CACHE_ENABLED：内存缓存
| 项目 | 说明 |
|---|---|
| One API | 原版项目基础 |
| Midjourney-Proxy | Midjourney 接口支持 |
| 项目 | 说明 |
|---|---|
| neko-api-key-tool | Key 额度查询工具 |
| new-api-horizon | New API 高性能优化版 |
| 资源 | 链接 |
|---|---|
| 📘 常见问题 | FAQ |
| 💬 社区交流 | 交流渠道 |
| 🐛 反馈问题 | 问题反馈 |
| 📚 完整文档 | 官方文档 |
欢迎各种形式的贡献！
- 🐛 报告 Bug
- 💡 提出新功能
- 📝 改进文档
- 🔧 提交代码
35/F,Tencent Building,Kejizhongyi Avenue,Nanshan District,Shenzhen
