new-api/README.md

 # New API 🍥 **新一代大模型网关与AI资产管理系统**

中文 | English | Français | 日本語

快速开始 • 主要特性 • 部署 • 文档 • 帮助

📝 项目说明

[!NOTE]
本项目为开源项目，在 One API 的基础上进行二次开发

[!IMPORTANT]

• 本项目仅供个人学习使用，不保证稳定性，且不提供任何技术支持
• 使用者必须在遵循 OpenAI 的 使用条款 以及法律法规的情况下使用，不得用于非法用途
• 根据 《生成式人工智能服务管理暂行办法》 的要求，请勿对中国地区公众提供一切未经备案的生成式人工智能服务

---

🤝 我们信任的合作伙伴

排名不分先后

---

🙏 特别鸣谢

感谢 JetBrains 为本项目提供免费的开源开发许可证

---

🚀 快速开始

使用 Docker Compose（推荐）

# 克隆项目
git clone https://github.com/QuantumNous/new-api.git
cd new-api

# 编辑 docker-compose.yml 配置
nano docker-compose.yml

# 启动服务
docker-compose up -d

使用 Docker 命令

```bash # 拉取最新镜像 docker pull calciumion/new-api:latest # 使用 SQLite（默认） docker run --name new-api -d --restart always \ -p 3000:3000 \ -e TZ=Asia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest # 使用 MySQL docker run --name new-api -d --restart always \ -p 3000:3000 \ -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \ -e TZ=Asia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest ``` > **💡 提示：** `-v ./data:/data` 会将数据保存在当前目录的 `data` 文件夹中，你也可以改为绝对路径如 `-v /your/custom/path:/data`

---

🎉 部署完成后，访问 http://localhost:3000 即可使用！

📖 更多部署方式请参考 部署指南

---

📚 文档

### 📖 [官方文档](https://docs.newapi.pro/zh/docs) | [](https://deepwiki.com/QuantumNous/new-api)

快速导航：

分类	链接
🚀 部署指南	安装文档
⚙️ 环境配置	环境变量
📡 接口文档	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 ⇄ Claude Messages
• 🔄 OpenAI ⇄ Gemini Chat
• 🔄 思考转内容功能

Reasoning Effort 支持：

查看详细配置

**OpenAI 系列模型：** - `o3-mini-high` - High reasoning effort - `o3-mini-medium` - Medium reasoning effort - `o3-mini-low` - Low reasoning effort - `gpt-5-high` - High reasoning effort - `gpt-5-medium` - Medium reasoning effort - `gpt-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 模式	-
🎯 自定义	支持完整调用地址	-

📡 支持的接口

查看完整接口列表

- [聊天接口 (Chat Completions)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-chat-completion) - [响应接口 (Responses)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-response) - [图像接口 (Image)](https://docs.newapi.pro/zh/docs/api/ai-model/images/openai/v1-images-generations--post) - [音频接口 (Audio)](https://docs.newapi.pro/zh/docs/api/ai-model/audio/openai/create-transcription) - [视频接口 (Video)](https://docs.newapi.pro/zh/docs/api/ai-model/videos/create-video-generation) - [嵌入接口 (Embeddings)](https://docs.newapi.pro/zh/docs/api/ai-model/embeddings/create-embedding) - [重排序接口 (Rerank)](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank) - [实时对话 (Realtime)](https://docs.newapi.pro/zh/docs/api/ai-model/realtime/create-realtime-session) - [Claude 聊天](https://docs.newapi.pro/zh/docs/api/ai-model/chat/create-message) - [Google Gemini 聊天](https://doc.newapi.pro/api/google-gemini-chat)

---

🚢 部署

[!TIP] 最新版 Docker 镜像： calciumion/new-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` | 📖 **完整配置：** [环境变量文档](https://docs.newapi.pro/zh/docs/installation/config-maintenance/environment-variables)

🔧 部署方式

方式 1：Docker Compose（推荐）

```bash # 克隆项目 git clone https://github.com/QuantumNous/new-api.git cd new-api # 编辑配置 nano docker-compose.yml # 启动服务 docker-compose up -d ```

方式 2：Docker 命令

**使用 SQLite：** ```bash docker run --name new-api -d --restart always \ -p 3000:3000 \ -e TZ=Asia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest ``` **使用 MySQL：** ```bash docker run --name new-api -d --restart always \ -p 3000:3000 \ -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \ -e TZ=Asia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest ``` > **💡 路径说明：** > - `./data:/data` - 相对路径，数据保存在当前目录的 data 文件夹 > - 也可使用绝对路径，如：`/your/custom/path:/data`

方式 3：宝塔面板

1. 安装宝塔面板（≥ 9.2.0 版本） 2. 在应用商店搜索 **New-API** 3. 一键安装 📖 [图文教程](./docs/BT.md)

⚠️ 多机部署注意事项

[!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
• 💡 提出新功能
• 📝 改进文档
• 🔧 提交代码

---

🌟 Star History

[](https://star-history.com/#Calcium-Ion/new-api&Date)

---

### 💖 感谢使用 New API 如果这个项目对你有帮助，欢迎给我们一个 ⭐️ Star！ **[官方文档](https://docs.newapi.pro/zh/docs)** • **[问题反馈](https://github.com/Calcium-Ion/new-api/issues)** • **[最新发布](https://github.com/Calcium-Ion/new-api/releases)** _{Built with ❤️ by QuantumNous}