No particular order

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

# 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

# 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

Quick Navigation:

For detailed features, please refer to Features Introduction

• ✅ 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

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

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:

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).

For details, please refer to API Documentation - Relay Interface

• 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

📖 Complete configuration: Environment Variables Documentation

# 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

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

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

📖 Tutorial with images

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

Cache configuration:

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

Welcome all forms of contribution!

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

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