
🍥 Next-Generation Large Model Gateway and AI Asset Management System
Quick Start • Key Features • Deployment • Documentation • Help
NOTE
This is an open-source project developed based on One API, maintained by 必创API team
IMPORTANT
No particular order
Thanks to JetBrains for providing free open-source development license for this project
# Clone the project
git clone https://gitee.com/buidai/buidapi.git
cd buidapi
# Edit docker-compose.yml configuration
nano docker-compose.yml
# Start the service
docker-compose up -d
# Pull the latest image
docker pull buidapi/buidai-api:latest
# Using SQLite (default)
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-api:latest
# Using MySQL
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-api:latest
💡 Tip:
-v ./data:/datawill save data in thedatafolder 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:
| Category | Link |
|---|---|
| 🚀 Deployment Guide | Installation Documentation |
| ⚙️ Environment Configuration | Environment Variables |
| 📡 API Documentation | API Documentation |
| ❓ FAQ | FAQ |
| 💬 Community Interaction | Communication Channels |
For detailed features, please refer to Features Introduction
| 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 |
API Format Support:
Intelligent Routing:
Format Conversion:
Reasoning Effort Support:
OpenAI series models:
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 thinking models:
claude-3-7-sonnet-20250219-thinking - Enable thinking modeGoogle Gemini series models:
gemini-2.5-flash-thinking - Enable thinking modegemini-2.5-flash-nothinking - Disable thinking modegemini-2.5-pro-thinking - Enable thinking modegemini-2.5-pro-thinking-128 - Enable thinking mode with thinking budget of 128 tokens-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
| Model Type | Description | Documentation |
|---|---|---|
| 🤖 OpenAI GPTs | gpt-4-gizmo-* series | - |
| 🎨 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 | - |
TIP
Latest Docker image: buidapi/buidai-api:latest
| 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 |
| 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
# Clone the project
git clone https://gitee.com/buidai/buidapi.git
cd buidapi
# Edit configuration
nano docker-compose.yml
# Start service
docker-compose up -d
Using SQLite:
docker run --name buidai-api -d --restart always \ -p 3000:3000 \ -e TZ=Asia/Shanghai \ -v ./data:/data \ buidapi/buidai-api:latest
Using MySQL:
docker run --name buidai-api -d --restart always \
-p 3000:3000 \
-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" \
-e TZ=Asia/Shanghai \
-v ./data:/data \
buidapi/buidai-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
WARNING
SESSION_SECRET - Otherwise login status inconsistentCRYPTO_SECRET - Otherwise data cannot be decryptedRetry configuration: Settings → Operation Settings → General Settings → Failure Retry Count
Cache configuration:
REDIS_CONN_STRING: Redis cache (recommended)MEMORY_CACHE_ENABLED: Memory cache| Project | Description |
|---|---|
| One API | Original project base |
| Midjourney-Proxy | Midjourney interface support |
| Project | Description |
|---|---|
| neko-api-key-tool | Key quota query tool |
| new-api-horizon | New API high-performance optimized version |
| Resource | Link |
|---|---|
| 📘 FAQ | FAQ |
| 💬 Community Interaction | Communication Channels |
| 🐛 Issue Feedback | Issue Feedback |
| 📚 Complete Documentation | Official Documentation |
Welcome all forms of contribution!
If this project is helpful to you, welcome to give us a ⭐️ Star!
Official Documentation • Issue Feedback • Latest Release
Built with ❤️ by 必创API team