![new-api](/web/public/logo.png) # New API πŸ₯ **Next-Generation Large Model Gateway and AI Asset Management System**

δΈ­ζ–‡ | English | FranΓ§ais | ζ—₯本θͺž

license release docker docker GoReportCard

Calcium-Ion%2Fnew-api | Trendshift

Quick Start β€’ Key Features β€’ Deployment β€’ Documentation β€’ Help

## πŸ“ Project Description > [!NOTE] > This is an open-source project developed based on [One API](https://github.com/songquanpeng/one-api) > [!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](https://openai.com/policies/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》](http://www.cac.gov.cn/2023-07/13/c_1690898327029107.htm), please do not provide any unregistered generative AI services to the public in China. --- ## 🀝 Trusted Partners

No particular order

Cherry Studio Peking University UCloud Alibaba Cloud IO.NET

--- ## πŸ™ Special Thanks

JetBrains Logo

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

--- ## πŸš€ Quick Start ### Using Docker Compose (Recommended) ```bash # 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 ```bash # 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](https://docs.newapi.pro/en/docs/installation) --- ## πŸ“š Documentation
### πŸ“– [Official Documentation](https://docs.newapi.pro/en/docs) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api)
**Quick Navigation:** | Category | Link | |------|------| | πŸš€ Deployment Guide | [Installation Documentation](https://docs.newapi.pro/en/docs/installation) | | βš™οΈ Environment Configuration | [Environment Variables](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables) | | πŸ“‘ API Documentation | [API Documentation](https://docs.newapi.pro/en/docs/api) | | ❓ FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | | πŸ’¬ Community Interaction | [Communication Channels](https://docs.newapi.pro/en/docs/support/community-interaction) | --- ## ✨ Key Features > For detailed features, please refer to [Features Introduction](https://docs.newapi.pro/en/docs/guide/wiki/basic-concepts/features-introduction) ### 🎨 Core Functions | Feature | Description | |------|------| | 🎨 New UI | Modern user interface design | | 🌍 Multi-language | Supports 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 ### πŸš€ Advanced Features **API Format Support:** - ⚑ [OpenAI Responses](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) - ⚑ [OpenAI Realtime API](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) (including Azure) - ⚑ [Claude Messages](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) - ⚑ [Google Gemini](https://doc.newapi.pro/en/api/google-gemini-chat) - πŸ”„ [Rerank Models](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) (Cohere, Jina) **Intelligent Routing:** - βš–οΈ Channel weighted random - πŸ”„ Automatic retry on failure - 🚦 User-level model rate limiting **Format Conversion:** - πŸ”„ OpenAI ⇄ Claude Messages - πŸ”„ OpenAI ⇄ Gemini Chat - πŸ”„ 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](https://docs.newapi.pro/en/docs/api) | Model Type | Description | Documentation | |---------|------|------| | πŸ€– OpenAI GPTs | gpt-4-gizmo-* series | - | | 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://doc.newapi.pro/en/api/midjourney-proxy-image) | | 🎡 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://doc.newapi.pro/en/api/suno-music) | | πŸ”„ Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) | | πŸ’¬ Claude | Messages format | [Documentation](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) | | 🌐 Gemini | Google Gemini format | [Documentation](https://doc.newapi.pro/en/api/google-gemini-chat) | | πŸ”§ Dify | ChatFlow mode | - | | 🎯 Custom | Supports complete call address | - | ### πŸ“‘ Supported Interfaces
View complete interface list - [Chat Interface (Chat Completions)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-chat-completion) - [Response Interface (Responses)](https://docs.newapi.pro/en/docs/api/ai-model/chat/openai/create-response) - [Image Interface (Image)](https://docs.newapi.pro/en/docs/api/ai-model/images/openai/v1-images-generations--post) - [Audio Interface (Audio)](https://docs.newapi.pro/en/docs/api/ai-model/audio/openai/create-transcription) - [Video Interface (Video)](https://docs.newapi.pro/en/docs/api/ai-model/videos/create-video-generation) - [Embedding Interface (Embeddings)](https://docs.newapi.pro/en/docs/api/ai-model/embeddings/create-embedding) - [Rerank Interface (Rerank)](https://docs.newapi.pro/en/docs/api/ai-model/rerank/create-rerank) - [Realtime Conversation (Realtime)](https://docs.newapi.pro/en/docs/api/ai-model/realtime/create-realtime-session) - [Claude Chat](https://docs.newapi.pro/en/docs/api/ai-model/chat/create-message) - [Google Gemini Chat](https://doc.newapi.pro/en/api/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](https://docs.newapi.pro/en/docs/installation/config-maintenance/environment-variables)
### πŸ”§ Deployment Methods
Method 1: Docker Compose (Recommended) ```bash # 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:** ```bash docker run --name new-api -d --restart always \ -p 3000:3000 \ -e TZ=Asia/Shanghai \ -v ./data:/data \ calciumion/new-api:latest ``` **Using MySQL:** ```bash 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](./docs/BT.md)
### ⚠️ Multi-machine Deployment Considerations > [!WARNING] > - **Must set** `SESSION_SECRET` - Otherwise login status inconsistent > - **Shared Redis must set** `CRYPTO_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](https://github.com/songquanpeng/one-api) | Original project base | | [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy) | Midjourney interface support | ### Supporting Tools | Project | Description | |------|------| | [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool) | Key quota query tool | | [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon) | New API high-performance optimized version | --- ## πŸ’¬ Help Support ### πŸ“– Documentation Resources | Resource | Link | |------|------| | πŸ“˜ FAQ | [FAQ](https://docs.newapi.pro/en/docs/support/faq) | | πŸ’¬ Community Interaction | [Communication Channels](https://docs.newapi.pro/en/docs/support/community-interaction) | | πŸ› Issue Feedback | [Issue Feedback](https://docs.newapi.pro/en/docs/support/feedback-issues) | | πŸ“š Complete Documentation | [Official Documentation](https://docs.newapi.pro/en/docs) | ### 🀝 Contribution Guide Welcome all forms of contribution! - πŸ› Report Bugs - πŸ’‘ Propose New Features - πŸ“ Improve Documentation - πŸ”§ Submit Code --- ## 🌟 Star History
[![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)
---
### πŸ’– Thank you for using New API If this project is helpful to you, welcome to give us a ⭐️ Star！ **[Official Documentation](https://docs.newapi.pro/en/docs)** β€’ **[Issue Feedback](https://github.com/Calcium-Ion/new-api/issues)** β€’ **[Latest Release](https://github.com/Calcium-Ion/new-api/releases)** Built with ❀️ by QuantumNous