[!NOTE] 本項目為開源項目,在 One API 的基礎上進行二次開發
[!IMPORTANT]
- 本項目僅供個人學習使用,不保證穩定性,且不提供任何技術支援
- 使用者必須在遵循 OpenAI 的 使用條款 以及法律法規的情況下使用,不得用於非法用途
- 根據 《生成式人工智慧服務管理暫行辦法》 的要求,請勿對中國地區公眾提供一切未經備案的生成式人工智慧服務
排名不分先後
感謝 JetBrains 為本項目提供免費的開源開發許可證
# 複製項目
git clone https://github.com/QuantumNous/new-api.git
cd new-api
# 編輯 docker-compose.yml 配置
nano docker-compose.yml
# 啟動服務
docker-compose up -d
使用 Docker 命令
# 拉取最新鏡像
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 即可使用!
📖 更多部署方式請參考 部署指南
快速導航:
| 分類 | 連結 |
|---|---|
| 🚀 部署指南 | 安裝文件 |
| ⚙️ 環境配置 | 環境變數 |
| 📡 接口文件 | API 文件 |
| ❓ 常見問題 | FAQ |
| 💬 社群交流 | 交流管道 |
詳細特性請參考 特性說明
| 特性 | 說明 |
|---|---|
| 🎨 全新 UI | 現代化的用戶界面設計 |
| 🌍 多語言 | 支援簡體中文、繁體中文、英文、法語、日語 |
| 🔄 數據兼容 | 完全兼容原版 One API 資料庫 |
| 📈 數據看板 | 視覺化控制檯與統計分析 |
| 🔒 權限管理 | 令牌分組、模型限制、用戶管理 |
API 格式支援:
智慧路由:
格式轉換:
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 effortClaude 思考模型:
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-low / -medium / -high 來控制思考力道(無需再設置思考預算後綴)詳情請參考 接口文件 - 中繼接口
| 模型類型 | 說明 | 文件 |
|---|---|---|
| 🤖 OpenAI-Compatible | OpenAI 兼容模型 | 文件 |
| 🤖 OpenAI Responses | OpenAI Responses 格式 | 文件 |
| 🎨 Midjourney-Proxy | Midjourney-Proxy(Plus) | 文件 |
| 🎵 Suno-API | Suno API | 文件 |
| 🔄 Rerank | Cohere、Jina | 文件 |
| 💬 Claude | Messages 格式 | 文件 |
| 🌐 Gemini | Google Gemini 格式 | 文件 |
| 🔧 Dify | ChatFlow 模式 | - |
| 🎯 自訂 | 支援完整調用位址 | - |
查看完整接口列表
[!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 |
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://github.com/QuantumNous/new-api.git
cd new-api
# 編輯配置
nano docker-compose.yml
# 啟動服務
docker-compose up -d
方式 2:Docker 命令
使用 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
💡 路徑說明:
./data:/data- 相對路徑,數據保存在當前目錄的 data 資料夾- 也可使用絕對路徑,如:
/your/custom/path:/data
方式 3:寶塔面板
📖 圖文教學
[!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 |
| 💬 社群交流 | 交流管道 |
| 🐛 回饋問題 | 問題回饋 |
| 📚 完整文件 | 官方文件 |
歡迎各種形式的貢獻!
本項目採用 GNU Affero 通用公共許可證 v3.0 (AGPLv3) 授權。
如果您所在的組織政策不允許使用 AGPLv3 許可的軟體,或您希望規避 AGPLv3 的開源義務,請發送郵件至:support@quantumnous.com