{"repo": "cherryinternal/newapi", "files": {"README.zh_CN.md": {"0d6a2f39b06b412b2b8aeddd0490370589c53a1d": {"t": 1785596163.1414015, "n": 14632, "h": "a162a6ef9eebad89", "c": "
\n\n![new-api](/web/public/logo.png)\n\n# New API\n\n🍥 **新一代大模型网关与AI资产管理系统**\n\n

\n 简体中文 |\n 繁體中文 |\n English |\n Français |\n 日本語\n

\n\n

\n \n \"license\"\n \n \"release\"\n \n \"docker\"\n \n \"GoReportCard\"\n \n

\n\n

\n \n \"QuantumNous%2Fnew-api\n \n
\n \n \"Featured｜HelloGitHub\"\n \n \"New\n \n

\n\n

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

\n\n
\n\n## 📝 项目说明\n\n> [!IMPORTANT]\n> - 本项目仅供个人学习使用，不保证稳定性，且不提供任何技术支持\n> - 使用者必须在遵循 OpenAI 的 [使用条款](https://openai.com/policies/terms-of-use) 以及**法律法规**的情况下使用，不得用于非法用途\n> - 根据 [《生成式人工智能服务管理暂行办法》](http://www.cac.gov.cn/2023-07/13/c_1690898327029107.htm) 的要求，请勿对中国地区公众提供一切未经备案的生成式人工智能服务\n\n---\n\n## 🤝 我们信任的合作伙伴\n\n

\n 排名不分先后\n

\n\n

\n \n \"Cherry\n \n \"Aion\n \n \"北京大学\"\n \n \"UCloud\n \n \"阿里云\"\n \n \"IO.NET\"\n \n

\n\n---\n\n## 🙏 特别鸣谢\n\n

\n \n \"JetBrains\n \n

\n\n

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

\n\n---\n\n## 🚀 快速开始\n\n### 使用 Docker Compose（推荐）\n\n```bash\n# 克隆项目\ngit clone https://github.com/QuantumNous/new-api.git\ncd new-api\n\n# 编辑 docker-compose.yml 配置\nnano docker-compose.yml\n\n# 启动服务\ndocker-compose up -d\n```\n\n
\n使用 Docker 命令\n\n```bash\n# 基于当前源码构建镜像\ndocker build -t new-api:local .\n\n# 使用 SQLite（默认）\nmkdir -p data\ndocker run --name new-api -d --restart always \\\n -p 3000:3000 \\\n -e HYDRA_ENABLED=false \\\n -e TZ=Asia/Shanghai \\\n -v \"$(pwd)/data:/data\" \\\n new-api:local\n\n# 使用 MySQL\nmkdir -p data\ndocker run --name new-api -d --restart always \\\n -p 3000:3000 \\\n -e HYDRA_ENABLED=false \\\n -e SQL_DSN=\"root:123456@tcp(localhost:3306)/oneapi?parseTime=true\" \\\n -e TZ=Asia/Shanghai \\\n -v \"$(pwd)/data:/data\" \\\n new-api:local\n```\n\n> **💡 提示：** 当前源码构建出的容器默认会尝试启动 Hydra，所以单容器启动时必须显式加上 `-e HYDRA_ENABLED=false`。`-v \"$(pwd)/data:/data\"` 会将 SQLite 数据和日志保存在当前目录的 `data` 文件夹中，也可以改成绝对路径，例如 `-v /your/custom/path:/data`。\n\n
\n\n---\n\n🎉 部署完成后，访问 `http://localhost:3000` 即可使用！\n\n📖 更多部署方式请参考 [部署指南](https://docs.newapi.pro/zh/docs/installation)\n\n---\n\n## 📚 文档\n\n
\n\n### 📖 [官方文档](https://docs.newapi.pro/zh/docs) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)\n\n
\n\n**快速导航：**\n\n| 分类 | 链接 |\n|------|------|\n| 🚀 部署指南 | [安装文档](https://docs.newapi.pro/zh/docs/installation) |\n| ⚙️ 环境配置 | [环境变量](https://docs.newapi.pro/zh/docs/installation/config-maintenance/environment-variables) |\n| 📡 接口文档 | [API 文档](https://docs.newapi.pro/zh/docs/api) |\n| ❓ 常见问题 | [FAQ](https://docs.newapi.pro/zh/docs/support/faq) |\n| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/zh/docs/support/community-interaction) |\n\n---\n\n## ✨ 主要特性\n\n> 详细特性请参考 [特性说明](https://docs.newapi.pro/zh/docs/guide/wiki/basic-concepts/features-introduction)\n\n### 🎨 核心功能\n\n| 特性 | 说明 |\n|------|------|\n| 🎨 全新 UI | 现代化的用户界面设计 |\n| 🌍 多语言 | 支持中文、英文、法语、日语 |\n| 🔄 数据兼容 | 完全兼容原版 One API 数据库 |\n| 📈 数据看板 | 可视化控制台与统计分析 |\n| 🔒 权限管理 | 令牌分组、模型限制、用户管理 |\n\n### 💰 支付与计费\n\n- ✅ 在线充值（易支付、Stripe）\n- ✅ 模型按次数收费\n- ✅ 缓存计费支持（OpenAI、Azure、DeepSeek、Claude、Qwen等所有支持的模型）\n- ✅ 灵活的计费策略配置\n\n### 🔐 授权与安全\n\n- 😈 Discord 授权登录\n- 🤖 LinuxDO 授权登录\n- 📱 Telegram 授权登录\n- 🔑 OIDC 统一认证\n- 🔍 Key 查询使用额度（配合 [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)）\n\n### 🚀 高级功能\n\n**API 格式支持：**\n- ⚡ [OpenAI Responses](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/create-response)\n- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/zh/docs/api/ai-model/realtime/create-realtime-session)（含 Azure）\n- ⚡ [Claude Messages](https://docs.newapi.pro/zh/docs/api/ai-model/chat/create-message)\n- ⚡ [Google Gemini](https://doc.newapi.pro/api/google-gemini-chat)\n- 🔄 [Rerank 模型](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank)（Cohere、Jina）\n\n**智能路由：**\n- ⚖️ 渠道加权随机\n- 🔄 失败自动重试\n- 🚦 用户级别模型限流\n\n**格式转换：**\n- 🔄 **OpenAI Compatible ⇄ Claude Messages**\n- 🔄 **OpenAI Compatible → Google Gemini**\n- 🔄 **Google Gemini → OpenAI Compatible** - 仅支持文本，暂不支持函数调用\n- 🚧 **OpenAI Compatible ⇄ OpenAI Responses** - 开发中\n- 🔄 **思考转内容功能**\n\n**Reasoning Effort 支持：**\n\n
\n查看详细配置\n\n**OpenAI 系列模型：**\n- `o3-mini-high` - High reasoning effort\n- `o3-mini-medium` - Medium reasoning effort\n- `o3-mini-low` - Low reasoning effort\n- `gpt-5-high` - High reasoning effort\n- `gpt-5-medium` - Medium reasoning effort\n- `gpt-5-low` - Low reasoning effort\n\n**Claude 思考模型：**\n- `claude-3-7-sonnet-20250219-thinking` - 启用思考模式\n\n**Google Gemini 系列模型：**\n- `gemini-2.5-flash-thinking` - 启用思考模式\n- `gemini-2.5-flash-nothinking` - 禁用思考模式\n- `gemini-2.5-pro-thinking` - 启用思考模式\n- `gemini-2.5-pro-thinking-128` - 启用思考模式，并设置思考预算为128tokens\n- 也可以直接在 Gemini 模型名称后追加 `-low` / `-medium` / `-high` 来控制思考力度（无需再设置思考预算后缀）\n\n
\n\n---\n\n## 🤖 模型支持\n\n> 详情请参考 [接口文档 - 中继接口](https://docs.newapi.pro/zh/docs/api)\n\n| 模型类型 | 说明 | 文档 |\n|---------|------|------|\n| 🤖 OpenAI-Compatible | OpenAI 兼容模型 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/createchatcompletion) |\n| 🤖 OpenAI Responses | OpenAI Responses 格式 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/createresponse) |\n| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [文档](https://doc.newapi.pro/api/midjourney-proxy-image) |\n| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [文档](https://doc.newapi.pro/api/suno-music) |\n| 🔄 Rerank | Cohere、Jina | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/create-rerank) |\n| 💬 Claude | Messages 格式 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/createmessage) |\n| 🌐 Gemini | Google Gemini 格式 | [文档](https://docs.newapi.pro/zh/docs/api/ai-model/chat/gemini/geminirelayv1beta) |\n| 🔧 Dify | ChatFlow 模式 | - |\n| 🎯 自定义 | 支持完整调用地址 | - |\n\n### 📡 支持的接口\n\n
\n查看完整接口列表\n\n- [聊天接口 (Chat Completions)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/createchatcompletion)\n- [响应接口 (Responses)](https://docs.newapi.pro/zh/docs/api/ai-model/chat/openai/createresponse)\n- [图像接口 (Image)](https://docs.newapi.pro/zh/docs/api/ai-model/images/openai/post-v1-images-generations)\n- [音频接口 (Audio)](https://docs.newapi.pro/zh/docs/api/ai-model/audio/openai/create-transcription)\n- [视频接口 (Video)](https://docs.newapi.pro/zh/docs/api/ai-model/audio/openai/createspeech)\n- [嵌入接口 (Embeddings)](https://docs.newapi.pro/zh/docs/api/ai-model/embeddings/createembedding)\n- [重排序接口 (Rerank)](https://docs.newapi.pro/zh/docs/api/ai-model/rerank/creatererank)\n- [实时对话 (Realtime)](https://docs.newapi.pro/zh/docs/api/ai-model/realtime/createrealtimesession)\n- [Claude 聊天](https://docs.newapi.pro/zh/docs/api/ai-model/chat/createmessage)\n- [Google Gemini 聊天](https://docs.newapi.pro/zh/docs/api/ai-model/chat/gemini/geminirelayv1beta)\n\n
\n\n---\n\n## 🚢 部署\n\n> [!TIP]\n> **基于当前源码使用 Docker 部署：** 请先本地构建镜像；如果是单容器启动，务必加上 `-e HYDRA_ENABLED=false`。\n\n### 📋 部署要求\n\n| 组件 | 要求 |\n|------|------|\n| **本地数据库** | SQLite（Docker 需挂载 `/data` 目录）|\n| **远程数据库** | MySQL ≥ 5.7.8 或 PostgreSQL ≥ 9.6 |\n| **容器引擎** | Docker / Docker Compose |\n\n### ⚙️ 环境变量配置\n\n
\n常用环境变量配置\n\n| 变量名 | 说明 | 默认值 |\n|--------|--------------------------------------------------------------|--------|\n| `SESSION_SECRET` | 会话密钥（多机部署必须） | - |\n| `CRYPTO_SECRET` | 加密密钥（Redis 必须） | - |\n| `SQL_DSN` | 数据库连接字符串 | - |\n| `REDIS_CONN_STRING` | Redis 连接字符串 | - |\n| `STREAMING_TIMEOUT` | 流式超时时间（秒） | `300` |\n| `STREAM_SCANNER_MAX_BUFFER_MB` | 流式扫描器单行最大缓冲（MB），图像生成等超大 `data:` 片段（如 4K 图片 base64）需适当调大 | `64` |\n| `MAX_REQUEST_BODY_MB` | 请求体最大大小（MB，**解压后**计；防止超大请求/zip bomb 导致内存暴涨），超过将返回 `413` | `32` |\n| `AZURE_DEFAULT_API_VERSION` | Azure API 版本 | `2025-04-01-preview` |\n| `ERROR_LOG_ENABLED` | 错误日志开关 | `false` |\n| `PYROSCOPE_URL` | Pyroscope 服务地址 | - |\n| `PYROSCOPE_APP_NAME` | Pyroscope 应用名 | `new-api` |\n| `PYROSCOPE_BASIC_AUTH_USER` | Pyroscope Basic Auth 用户名 | - |\n| `PYROSCOPE_BASIC_AUTH_PASSWORD` | Pyroscope Basic Auth 密码 | - |\n| `PYROSCOPE_MUTEX_RATE` | Pyroscope mutex 采样率 | `5` |\n| `PYROSCOPE_BLOCK_RATE` | Pyroscope block 采样率 | `5` |\n| `HOSTNAME` | Pyroscope 标签里的主机名 | `new-api` |\n\n📖 **完整配置：** [环境变量文档](https://docs.newapi.pro/zh/docs/installation/config-maintenance/environment-variables)\n\n
\n\n### 🔧 部署方式\n\n
\n方式 1：Docker Compose（推荐）\n\n```bash\n# 克隆项目\ngit clone https://github.com/QuantumNous/new-api.git\ncd new-api\n\n# 编辑配置\nnano docker-compose.yml\n\n# 启动服务\ndocker-compose up -d\n```\n\n
\n\n
\n方式 2：Docker 命令\n\n**使用 SQLite：**\n```bash\ndocker build -t new-api:local .\nmkdir -p data\ndocker run --name new-api -d --restart always \\\n -p 3000:3000 \\\n -e HYDRA_ENABLED=false \\\n -e TZ=Asia/Shanghai \\\n -v \"$(pwd)/data:/data\" \\\n new-api:local\n```\n\n**使用 MySQL：**\n```bash\ndocker build -t new-api:local .\nmkdir -p data\ndocker run --name new-api -d --restart always \\\n -p 3000:3000 \\\n -e HYDRA_ENABLED=false \\\n -e SQL_DSN=\"root:123456@tcp(localhost:3306)/oneapi?parseTime=true\" \\\n -e TZ=Asia/Shanghai \\\n -v \"$(pwd)/data:/data\" \\\n new-api:local\n```\n\n> **💡 路径说明：**\n> - 当前源码的单容器启动必须设置 `HYDRA_ENABLED=false`\n> - `$(pwd)/data:/data` 会把 SQLite 数据和日志保存在当前目录的 data 文件夹\n> - 也可使用绝对路径，如：`/your/custom/path:/data`\n\n
\n\n
\n方式 3：宝塔面板\n\n1. 安装宝塔面板（≥ 9.2.0 版本）\n2. 在应用商店搜索 **New-API**\n3. 一键安装\n\n📖 [图文教程](./docs/installation/BT.md)\n\n
\n\n### ⚠️ 多机部署注意事项\n\n> [!WARNING]\n> - **必须设置** `SESSION_SECRET` - 否则登录状态不一致\n> - **公用 Redis 必须设置** `CRYPTO_SECRET` - 否则数据无法解密\n\n### 🔄 渠道重试与缓存\n\n**重试配置：** `设置 → 运营设置 → 通用设置 → 失败重试次数`\n\n**缓存配置：**\n- `REDIS_CONN_STRING`：Redis 缓存（推荐）\n- `MEMORY_CACHE_ENABLED`：内存缓存\n\n---\n\n## 🔗 相关项目\n\n### 上游项目\n\n| 项目 | 说明 |\n|------|------|\n| [One API](https://github.com/songquanpeng/one-api) | 原版项目基础 |\n| [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy) | Midjourney 接口支持 |\n\n### 配套工具\n\n| 项目 | 说明 |\n|------|------|\n| [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool) | Key 额度查询工具 |\n| [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon) | New API 高性能优化版 |\n\n---\n\n## 💬 帮助支持\n\n### 📖 文档资源\n\n| 资源 | 链接 |\n|------|------|\n| 📘 常见问题 | [FAQ](https://docs.newapi.pro/zh/docs/support/faq) |\n| 💬 社区交流 | [交流渠道](https://docs.newapi.pro/zh/docs/support/community-interaction) |\n| 🐛 反馈问题 | [问题反馈](https://docs.newapi.pro/zh/docs/support/feedback-issues) |\n| 📚 完整文档 | [官方文档](https://docs.newapi.pro/zh/docs) |\n\n### 🤝 贡献指南\n\n欢迎各种形式的贡献！\n\n- 🐛 报告 Bug\n- 💡 提出新功能\n- 📝 改进文档\n- 🔧 提交代码\n\n---\n\n## 📜 许可证\n\n本项目采用 [GNU Affero 通用公共许可证 v3.0 (AGPLv3)](./LICENSE) 授权。\n\n本项目为开源项目，在 [One API](https://github.com/songquanpeng/one-api)（MIT 许可证）的基础上进行二次开发。\n\n如果您所在的组织政策不允许使用 AGPLv3 许可的软件，或您希望规避 AGPLv3 的开源义务，请发送邮件至：[support@quantumnous.com](mailto:support@quantumnous.com)\n\n---\n\n## 🌟 Star History\n\n
\n\n[![Star History Chart](https://api.star-history.com/svg?repos=Calcium-Ion/new-api&type=Date)](https://star-history.com/#Calcium-Ion/new-api&Date)\n\n
\n\n---\n\n
\n\n### 💖 感谢使用 New API\n\n如果这个项目对你有帮助，欢迎给我们一个 ⭐️ Star！\n\n**[官方文档](https://docs.newapi.pro/zh/docs)** • **[问题反馈](https://github.com/Calcium-Ion/new-api/issues)** • **[最新发布](https://github.com/Calcium-Ion/new-api/releases)**\n\nBuilt with ❤️ by QuantumNous\n\n
\n"}}}}