📝 Project Description

🤝 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

# 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

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

📖 For more deployment methods, please refer to Deployment Guide

📚 Documentation

Quick Navigation:

✨ Key Features

For detailed features, please refer to Features Introduction

🎨 Core Functions

💰 Authorized Usage Accounting and Billing

• ✅ Internal top-up and quota allocation for lawful authorized scenarios (EPay, Stripe)
• ✅ Organization-level per-request, usage-based, and cache-hit cost accounting
• ✅ Cache billing statistics for OpenAI, Azure, DeepSeek, Claude, Qwen, and supported models
• ✅ Flexible billing policies for internal management or authorized enterprise customers

🔐 Authorization and Security

• 😈 Discord authorization login
• 🤖 LinuxDO authorization login
• 📱 Telegram authorization login
• 🔑 OIDC unified authentication
• 🔍 Key quota query usage (with new-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:

🤖 Model Support

For details, please refer to API Documentation - Gateway Interface

📡 Supported Interfaces

🚢 Deployment

📋 Deployment Requirements

⚙️ Environment Variable Configuration

🔧 Deployment Methods

# 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

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

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

⚠️ Multi-machine Deployment Considerations

🔄 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

Supporting Tools

💬 Help Support

📖 Documentation Resources

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

Additional terms under AGPLv3 Section 7 apply. Modified versions must preserve the author attribution notice Frontend design and development by New API contributors. in the appropriate legal notices and in any prominent about, legal, footer, or attribution location presented by the user interface.

Modified versions that present a user interface must also preserve a visible link to the original project: https://github.com/QuantumNous/new-api.

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