New API

🍥 Next-Generation LLM Gateway and AI Asset Management System

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

Quick Start • Key Features • Deployment • Documentation • Help

📝 Project Description

Important

• This project is for personal learning purposes only, with no guarantee of stability or technical support
• Users must comply with OpenAI's Terms of Use and applicable laws and regulations, and must not use it for illegal purposes
• According to the 《Interim Measures for the Management of Generative Artificial Intelligence Services》, please do not provide any unregistered generative AI services to the public in China.

---

🤝 Trusted Partners

No particular order

---

🙏 Special Thanks

Thanks to JetBrains for providing free open-source development license for this project

---

🚀 Quick Start

Using Docker Compose (Recommended)

# Clone the project
git clone https://github.com/QuantumNous/new-api.git
cd new-api
# Edit docker-compose.yml configuration
nano docker-compose.yml
# Start the service
docker-compose up -d

Using Docker Commands

# Pull the latest image
docker pull calciumion/new-api:latest
# Using SQLite (default)
docker run --name new-api -d --restart always \
-p 3000:3000 \
-e TZ=Asia/Shanghai \
-v ./data:/data \
calciumion/new-api:latest
# Using 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

💡 Tip:-v ./data:/data will save data in the data folder of the current directory, you can also change it to an absolute path like -v /your/custom/path:/data

---

🎉 After deployment is complete, visit http://localhost:3000 to start using!

📖 For more deployment methods, please refer to Deployment Guide

---

📚 Documentation

📖 Official Documentation |

Quick Navigation:

Category	Link
🚀 Deployment Guide	Installation Documentation
⚙️ Environment Configuration	Environment Variables
📡 API Documentation	API Documentation
❓ FAQ	FAQ
💬 Community Interaction	Communication Channels

---

✨ Key Features

For detailed features, please refer to Features Introduction

🎨 Core Functions

Feature	Description
🎨 New UI	Modern user interface design
🌍 Multi-language	Supports Simplified Chinese, Traditional Chinese, English, French, Japanese
🔄 Data Compatibility	Fully compatible with the original One API database
📈 Data Dashboard	Visual console and statistical analysis
🔒 Permission Management	Token grouping, model restrictions, user management

💰 Payment and Billing

• ✅ Online recharge (EPay, Stripe)
• ✅ Pay-per-use model pricing
• ✅ Cache billing support (OpenAI, Azure, DeepSeek, Claude, Qwen and all supported models)
• ✅ Flexible billing policy configuration

🔐 Authorization and Security

• 😈 Discord authorization login
• 🤖 LinuxDO authorization login
• 📱 Telegram authorization login
• 🔑 OIDC unified authentication
• 🔍 Key quota query usage (with neko-api-key-tool)

🚀 Advanced Features

API Format Support:

• ⚡ OpenAI Responses
• ⚡ OpenAI Realtime API (including Azure)
• ⚡ Claude Messages
• ⚡ Google Gemini
• 🔄 Rerank Models (Cohere, Jina)

Intelligent Routing:

• ⚖️ Channel weighted random
• 🔄 Automatic retry on failure
• 🚦 User-level model rate limiting

Format Conversion:

• 🔄 OpenAI Compatible ⇄ Claude Messages
• 🔄 OpenAI Compatible → Google Gemini
• 🔄 Google Gemini → OpenAI Compatible - Text only, function calling not supported yet
• 🚧 OpenAI Compatible ⇄ OpenAI Responses - In development
• 🔄 Thinking-to-content functionality

Reasoning Effort Support:

View detailed configuration

OpenAI series models:

• 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 thinking models:

• claude-3-7-sonnet-20250219-thinking - Enable thinking mode

Google Gemini series models:

• gemini-2.5-flash-thinking - Enable thinking mode
• gemini-2.5-flash-nothinking - Disable thinking mode
• gemini-2.5-pro-thinking - Enable thinking mode
• gemini-2.5-pro-thinking-128 - Enable thinking mode with thinking budget of 128 tokens
• You can also append -low, -medium, or -high to any Gemini model name to request the corresponding reasoning effort (no extra thinking-budget suffix needed).

---

🤖 Model Support

For details, please refer to API Documentation - Relay Interface

Model Type	Description	Documentation
🤖 OpenAI-Compatible	OpenAI compatible models	Documentation
🤖 OpenAI Responses	OpenAI Responses format	Documentation
🎨 Midjourney-Proxy	Midjourney-Proxy(Plus)	Documentation
🎵 Suno-API	Suno API	Documentation
🔄 Rerank	Cohere, Jina	Documentation
💬 Claude	Messages format	Documentation
🌐 Gemini	Google Gemini format	Documentation
🔧 Dify	ChatFlow mode	-
🎯 Custom	Supports complete call address	-

📡 Supported Interfaces

View complete interface list

• Chat Interface (Chat Completions)
• Response Interface (Responses)
• Image Interface (Image)
• Audio Interface (Audio)
• Video Interface (Video)
• Embedding Interface (Embeddings)
• Rerank Interface (Rerank)
• Realtime Conversation (Realtime)
• Claude Chat
• Google Gemini Chat

---

🚢 Deployment

Tip

Latest Docker image:calciumion/new-api:latest

📋 Deployment Requirements

Component	Requirement
Local database	SQLite (Docker must mount /data directory)
Remote database	MySQL ≥ 5.7.8 or PostgreSQL ≥ 9.6
Container engine	Docker / Docker Compose

⚙️ Environment Variable Configuration

Common environment variable configuration

Variable Name	Description	Default Value
SESSION_SECRET	Session secret (required for multi-machine deployment)	-
CRYPTO_SECRET	Encryption secret (required for Redis)	-
SQL_DSN	Database connection string	-
REDIS_CONN_STRING	Redis connection string	-
STREAMING_TIMEOUT	Streaming timeout (seconds)	300
STREAM_SCANNER_MAX_BUFFER_MB	Max per-line buffer (MB) for the stream scanner; increase when upstream sends huge image/base64 payloads	64
MAX_REQUEST_BODY_MB	Max request body size (MB, counted after decompression; prevents huge requests/zip bombs from exhausting memory). Exceeding it returns 413	32
AZURE_DEFAULT_API_VERSION	Azure API version	2025-04-01-preview
ERROR_LOG_ENABLED	Error log switch	false
PYROSCOPE_URL	Pyroscope server address	-
PYROSCOPE_APP_NAME	Pyroscope application name	new-api
PYROSCOPE_BASIC_AUTH_USER	Pyroscope basic auth user	-
PYROSCOPE_BASIC_AUTH_PASSWORD	Pyroscope basic auth password	-
PYROSCOPE_MUTEX_RATE	Pyroscope mutex sampling rate	5
PYROSCOPE_BLOCK_RATE	Pyroscope block sampling rate	5
HOSTNAME	Hostname tag for Pyroscope	new-api

📖 Complete configuration:Environment Variables Documentation

🔧 Deployment Methods

Method 1: Docker Compose (Recommended)

# Clone the project
git clone https://github.com/QuantumNous/new-api.git
cd new-api
# Edit configuration
nano docker-compose.yml
# Start service
docker-compose up -d

Method 2: Docker Commands

Using SQLite:

docker run --name new-api -d --restart always \
-p 3000:3000 \
-e TZ=Asia/Shanghai \
-v ./data:/data \
calciumion/new-api:latest

Using 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

💡 Path explanation:

• ./data:/data - Relative path, data saved in the data folder of the current directory
• You can also use absolute path, e.g.: /your/custom/path:/data

Method 3: BaoTa Panel

1. Install BaoTa Panel (≥ 9.2.0 version)
2. Search for New-API in the application store
3. One-click installation

📖 Tutorial with images

⚠️ Multi-machine Deployment Considerations

Warning

• Must setSESSION_SECRET - Otherwise login status inconsistent
• Shared Redis must setCRYPTO_SECRET - Otherwise data cannot be decrypted

🔄 Channel Retry and Cache

Retry configuration:Settings → Operation Settings → General Settings → Failure Retry Count

Cache configuration:

• REDIS_CONN_STRING: Redis cache (recommended)
• MEMORY_CACHE_ENABLED: Memory cache

---

🔗 Related Projects

Upstream Projects

Project	Description
One API	Original project base
Midjourney-Proxy	Midjourney interface support

Supporting Tools

Project	Description
neko-api-key-tool	Key quota query tool
new-api-horizon	New API high-performance optimized version

---

💬 Help Support

📖 Documentation Resources

Resource	Link
📘 FAQ	FAQ
💬 Community Interaction	Communication Channels
🐛 Issue Feedback	Issue Feedback
📚 Complete Documentation	Official Documentation

🤝 Contribution Guide

Welcome all forms of contribution!

• 🐛 Report Bugs
• 💡 Propose New Features
• 📝 Improve Documentation
• 🔧 Submit Code

---

📜 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPLv3).

This is an open-source project developed based on One API (MIT License).

If your organization's policies do not permit the use of AGPLv3-licensed software, or if you wish to avoid the open-source obligations of AGPLv3, please contact us at: support@quantumnous.com

---

🌟 Star History

---

💖 Thank you for using New API

If this project is helpful to you, welcome to give us a ⭐️ Star！

Official Documentation • Issue Feedback • Latest Release

_{Built with ❤️ by QuantumNous}