Back to New Api

New API

README.zh_CN.md

0.13.217.0 KB
Original Source
<div align="center">

New API

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

<p align="center"> 简体中文 | <a href="./README.zh_TW.md">繁體中文</a> | <a href="./README.md">English</a> | <a href="./README.fr.md">Français</a> | <a href="./README.ja.md">日本語</a> </p> <p align="center"> <a href="https://raw.githubusercontent.com/Calcium-Ion/new-api/main/LICENSE">

</a><!-- --><a href="https://github.com/Calcium-Ion/new-api/releases/latest">

</a><!-- --><a href="https://hub.docker.com/r/CalciumIon/new-api">

</a><!-- --><a href="https://goreportcard.com/report/github.com/Calcium-Ion/new-api">

</a> </p> <p align="center"> <a href="https://trendshift.io/repositories/20180" target="_blank"> </a> <a href="https://hellogithub.com/repository/QuantumNous/new-api" target="_blank">

</a><!-- --><a href="https://www.producthunt.com/products/new-api/launches/new-api?embed=true&utm_source=badge-featured&utm_medium=badge&utm_campaign=badge-new-api" target="_blank" rel="noopener noreferrer">

</a> </p> <p align="center"> <a href="#-快速开始">快速开始</a> • <a href="#-主要特性">主要特性</a> • <a href="#-部署">部署</a> • <a href="#-文档">文档</a> • <a href="#-帮助支持">帮助</a> </p> </div>

📝 项目说明

[!IMPORTANT]

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

🤝 我们信任的合作伙伴

<p align="center"> <em>排名不分先后</em> </p> <p align="center"> <a href="https://www.cherry-ai.com/" target="_blank">

</a><!-- --><a href="https://github.com/iOfficeAI/AionUi/" target="_blank">

</a><!-- --><a href="https://bda.pku.edu.cn/" target="_blank">

</a><!-- --><a href="https://www.compshare.cn/?ytag=GPU_yy_gh_newapi" target="_blank">

</a><!-- --><a href="https://www.aliyun.com/" target="_blank">

</a><!-- --><a href="https://io.net/" target="_blank">

</a> </p>

🙏 特别鸣谢

<p align="center"> <a href="https://www.jetbrains.com/?from=new-api" target="_blank"> </a> </p> <p align="center"> <strong>感谢 <a href="https://www.jetbrains.com/?from=new-api">JetBrains</a> 为本项目提供免费的开源开发许可证</strong> </p>

🚀 快速开始

使用 Docker Compose(推荐)

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

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

# 启动服务
docker-compose up -d
<details> <summary><strong>使用 Docker 命令</strong></summary>
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

</details>

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

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


📚 文档

<div align="center">

📖 官方文档 |

</div>

快速导航:

分类链接
🚀 部署指南安装文档
⚙️ 环境配置环境变量
📡 接口文档API 文档
❓ 常见问题FAQ
💬 社区交流交流渠道

✨ 主要特性

详细特性请参考 特性说明

🎨 核心功能

特性说明
🎨 全新 UI现代化的用户界面设计
🌍 多语言支持中文、英文、法语、日语
🔄 数据兼容完全兼容原版 One API 数据库
📈 数据看板可视化控制台与统计分析
🔒 权限管理令牌分组、模型限制、用户管理

💰 支付与计费

  • ✅ 在线充值(易支付、Stripe)
  • ✅ 模型按次数收费
  • ✅ 缓存计费支持(OpenAI、Azure、DeepSeek、Claude、Qwen等所有支持的模型)
  • ✅ 灵活的计费策略配置

🔐 授权与安全

  • 😈 Discord 授权登录
  • 🤖 LinuxDO 授权登录
  • 📱 Telegram 授权登录
  • 🔑 OIDC 统一认证
  • 🔍 Key 查询使用额度(配合 neko-api-key-tool

🚀 高级功能

API 格式支持:

智能路由:

  • ⚖️ 渠道加权随机
  • 🔄 失败自动重试
  • 🚦 用户级别模型限流

格式转换:

  • 🔄 OpenAI Compatible ⇄ Claude Messages
  • 🔄 OpenAI Compatible → Google Gemini
  • 🔄 Google Gemini → OpenAI Compatible - 仅支持文本,暂不支持函数调用
  • 🚧 OpenAI Compatible ⇄ OpenAI Responses - 开发中
  • 🔄 思考转内容功能

Reasoning Effort 支持:

<details> <summary>查看详细配置</summary>

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 来控制思考力度(无需再设置思考预算后缀)
</details>

🤖 模型支持

详情请参考 接口文档 - 中继接口

模型类型说明文档
🤖 OpenAI-CompatibleOpenAI 兼容模型文档
🤖 OpenAI ResponsesOpenAI Responses 格式文档
🎨 Midjourney-ProxyMidjourney-Proxy(Plus)文档
🎵 Suno-APISuno API文档
🔄 RerankCohere、Jina文档
💬 ClaudeMessages 格式文档
🌐 GeminiGoogle Gemini 格式文档
🔧 DifyChatFlow 模式-
🎯 自定义支持完整调用地址-

📡 支持的接口

<details> <summary>查看完整接口列表</summary> </details>

🚢 部署

[!TIP] 最新版 Docker 镜像: calciumion/new-api:latest

📋 部署要求

组件要求
本地数据库SQLite(Docker 需挂载 /data 目录)
远程数据库MySQL ≥ 5.7.8 或 PostgreSQL ≥ 9.6
容器引擎Docker / Docker Compose

⚙️ 环境变量配置

<details> <summary>常用环境变量配置</summary>
变量名说明默认值
SESSION_SECRET会话密钥(多机部署必须)-
CRYPTO_SECRET加密密钥(Redis 必须)-
SQL_DSN数据库连接字符串-
REDIS_CONN_STRINGRedis 连接字符串-
STREAMING_TIMEOUT流式超时时间(秒)300
STREAM_SCANNER_MAX_BUFFER_MB流式扫描器单行最大缓冲(MB),图像生成等超大 data: 片段(如 4K 图片 base64)需适当调大64
MAX_REQUEST_BODY_MB请求体最大大小(MB,解压后计;防止超大请求/zip bomb 导致内存暴涨),超过将返回 41332
AZURE_DEFAULT_API_VERSIONAzure API 版本2025-04-01-preview
ERROR_LOG_ENABLED错误日志开关false
PYROSCOPE_URLPyroscope 服务地址-
PYROSCOPE_APP_NAMEPyroscope 应用名new-api
PYROSCOPE_BASIC_AUTH_USERPyroscope Basic Auth 用户名-
PYROSCOPE_BASIC_AUTH_PASSWORDPyroscope Basic Auth 密码-
PYROSCOPE_MUTEX_RATEPyroscope mutex 采样率5
PYROSCOPE_BLOCK_RATEPyroscope block 采样率5
HOSTNAMEPyroscope 标签里的主机名new-api

📖 完整配置: 环境变量文档

</details>

🔧 部署方式

<details> <summary><strong>方式 1:Docker Compose(推荐)</strong></summary>
bash
# 克隆项目
git clone https://github.com/QuantumNous/new-api.git
cd new-api

# 编辑配置
nano docker-compose.yml

# 启动服务
docker-compose up -d
</details> <details> <summary><strong>方式 2:Docker 命令</strong></summary>

使用 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
</details> <details> <summary><strong>方式 3:宝塔面板</strong></summary>
  1. 安装宝塔面板(≥ 9.2.0 版本)
  2. 在应用商店搜索 New-API
  3. 一键安装

📖 图文教程

</details>

⚠️ 多机部署注意事项

[!WARNING]

  • 必须设置 SESSION_SECRET - 否则登录状态不一致
  • 公用 Redis 必须设置 CRYPTO_SECRET - 否则数据无法解密

🔄 渠道重试与缓存

重试配置: 设置 → 运营设置 → 通用设置 → 失败重试次数

缓存配置:

  • REDIS_CONN_STRING:Redis 缓存(推荐)
  • MEMORY_CACHE_ENABLED:内存缓存

🔗 相关项目

上游项目

项目说明
One API原版项目基础
Midjourney-ProxyMidjourney 接口支持

配套工具

项目说明
neko-api-key-toolKey 额度查询工具
new-api-horizonNew API 高性能优化版

💬 帮助支持

📖 文档资源

资源链接
📘 常见问题FAQ
💬 社区交流交流渠道
🐛 反馈问题问题反馈
📚 完整文档官方文档

🤝 贡献指南

欢迎各种形式的贡献!

  • 🐛 报告 Bug
  • 💡 提出新功能
  • 📝 改进文档
  • 🔧 提交代码

📜 许可证

本项目采用 GNU Affero 通用公共许可证 v3.0 (AGPLv3) 授权。

本项目为开源项目,在 One API(MIT 许可证)的基础上进行二次开发。

如果您所在的组织政策不允许使用 AGPLv3 许可的软件,或您希望规避 AGPLv3 的开源义务,请发送邮件至:[email protected]


🌟 Star History

<div align="center">

</div>
<div align="center">

💖 感谢使用 New API

如果这个项目对你有帮助,欢迎给我们一个 ⭐️ Star!

官方文档问题反馈最新发布

<sub>Built with ❤️ by QuantumNous</sub>

</div>