From d56e162c996f56620b3033422f0f09809a311f8c Mon Sep 17 00:00:00 2001 From: CaIon Date: Sun, 9 Nov 2025 14:01:42 +0800 Subject: [PATCH] =?UTF-8?q?=E5=90=8C=E6=AD=A5=E5=A4=9A=E8=AF=AD=E8=A8=80RE?= =?UTF-8?q?ADME=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 更新中文README.md中的语言链接 - 完全重写英文README.en.md，包含所有详细功能说明 - 完全重写法文README.fr.md，确保内容一致性 - 完全重写日文README.ja.md，提供完整的项目说明 所有语言版本现在具有： - 相同的结构和格式 - 一致的语言导航 - 完整的功能特性和部署指南 - 统一的环境变量配置说明 --- README.en.md | 539 +++++++++++++++++++++++++++++++++++--------------- README.fr.md | 536 +++++++++++++++++++++++++++++++++++--------------- README.ja.md | 542 ++++++++++++++++++++++++++++++++++++--------------- 3 files changed, 1139 insertions(+), 478 deletions(-) diff --git a/README.en.md b/README.en.md index 54f4274a5..e51d4c89a 100644 --- a/README.en.md +++ b/README.en.md @@ -1,19 +1,17 @@ -

- 中文 | English | Français | 日本語 -

- -> [!NOTE] -> **MT (Machine Translation)**: This document is machine translated. For the most accurate information, please refer to the [Chinese version](./README.md). -
![new-api](/web/public/logo.png) # New API -🍥 Next-Generation Large Model Gateway and AI Asset Management System +🍥 **Next-Generation Large Model Gateway and AI Asset Management System** -Calcium-Ion%2Fnew-api | Trendshift +

+ 中文 | + English | + Français | + 日本語 +

@@ -32,6 +30,21 @@ GoReportCard

+ +

+ + Calcium-Ion%2Fnew-api | Trendshift + +

+ +

+ Quick Start • + Key Features • + Deployment • + Documentation • + Help +

+
## 📝 Project Description @@ -40,186 +53,394 @@ > 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. +> - 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

+--- + +## 🤝 Trusted Partners +

- Cherry Studio - Peking University - UCloud - Alibaba Cloud - IO.NET + No particular order

-

 

-## 📚 Documentation +

+ + Cherry Studio + + + Peking University + + + UCloud + + + Alibaba Cloud + + + IO.NET + +

-For detailed documentation, please visit our official Wiki: [https://docs.newapi.pro/](https://docs.newapi.pro/) +--- -You can also access the AI-generated DeepWiki: -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +## 🙏 Special Thanks -## ✨ Key Features +

+ + JetBrains Logo + +

-New API offers a wide range of features, please refer to [Features Introduction](https://docs.newapi.pro/wiki/features-introduction) for details: +

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

-1. 🎨 Brand new UI interface -2. 🌍 Multi-language support -3. 💰 Online recharge functionality, currently supports EPay and Stripe -4. 🔍 Support for querying usage quotas with keys (works with [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)) -5. 🔄 Compatible with the original One API database -6. 💵 Support for pay-per-use model pricing -7. ⚖️ Support for weighted random channel selection -8. 📈 Data dashboard (console) -9. 🔒 Token grouping and model restrictions -10. 🤖 Support for more authorization login methods (LinuxDO, Telegram, OIDC) -11. 🔄 Support for Rerank models (Cohere and Jina), [API Documentation](https://docs.newapi.pro/api/jinaai-rerank) -12. ⚡ Support for OpenAI Realtime API (including Azure channels), [API Documentation](https://docs.newapi.pro/api/openai-realtime) -13. ⚡ Support for **OpenAI Responses** format, [API Documentation](https://docs.newapi.pro/api/openai-responses) -14. ⚡ Support for **Claude Messages** format, [API Documentation](https://docs.newapi.pro/api/anthropic-chat) -15. ⚡ Support for **Google Gemini** format, [API Documentation](https://docs.newapi.pro/api/google-gemini-chat/) -16. 🧠 Support for setting reasoning effort through model name suffixes: - 1. OpenAI o-series models - - Add `-high` suffix for high reasoning effort (e.g.: `o3-mini-high`) - - Add `-medium` suffix for medium reasoning effort (e.g.: `o3-mini-medium`) - - Add `-low` suffix for low reasoning effort (e.g.: `o3-mini-low`) - 2. Claude thinking models - - Add `-thinking` suffix to enable thinking mode (e.g.: `claude-3-7-sonnet-20250219-thinking`) -17. 🔄 Thinking-to-content functionality -18. 🔄 Model rate limiting for users -19. 🔄 Request format conversion functionality, supporting the following three format conversions: - 1. OpenAI Chat Completions => Claude Messages - 2. Claude Messages => OpenAI Chat Completions (can be used for Claude Code to call third-party models) - 3. OpenAI Chat Completions => Gemini Chat -20. 💰 Cache billing support, which allows billing at a set ratio when cache is hit: - 1. Set the `Prompt Cache Ratio` option in `System Settings-Operation Settings` - 2. Set `Prompt Cache Ratio` in the channel, range 0-1, e.g., setting to 0.5 means billing at 50% when cache is hit - 3. Supported channels: - - [x] OpenAI - - [x] Azure - - [x] DeepSeek - - [x] Claude +--- -## Model Support +## 🚀 Quick Start -This version supports multiple models, please refer to [API Documentation-Relay Interface](https://docs.newapi.pro/api) for details: +### Using Docker Compose (Recommended) -1. Third-party models **gpts** (gpt-4-gizmo-*) -2. Third-party channel [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) interface, [API Documentation](https://docs.newapi.pro/api/midjourney-proxy-image) -3. Third-party channel [Suno API](https://github.com/Suno-API/Suno-API) interface, [API Documentation](https://docs.newapi.pro/api/suno-music) -4. Custom channels, supporting full call address input -5. Rerank models ([Cohere](https://cohere.ai/) and [Jina](https://jina.ai/)), [API Documentation](https://docs.newapi.pro/api/jinaai-rerank) -6. Claude Messages format, [API Documentation](https://docs.newapi.pro/api/anthropic-chat) -7. Google Gemini format, [API Documentation](https://docs.newapi.pro/api/google-gemini-chat/) -8. Dify, currently only supports chatflow -9. For more interfaces, please refer to [API Documentation](https://docs.newapi.pro/api) - -## Environment Variable Configuration - -For detailed configuration instructions, please refer to [Installation Guide-Environment Variables Configuration](https://docs.newapi.pro/installation/environment-variables): - -- `GENERATE_DEFAULT_TOKEN`: Whether to generate initial tokens for newly registered users, default is `false` -- `STREAMING_TIMEOUT`: Streaming response timeout, default is 300 seconds -- `DIFY_DEBUG`: Whether to output workflow and node information for Dify channels, default is `true` -- `GET_MEDIA_TOKEN`: Whether to count image tokens, default is `true` -- `GET_MEDIA_TOKEN_NOT_STREAM`: Whether to count image tokens in non-streaming cases, default is `true` -- `UPDATE_TASK`: Whether to update asynchronous tasks (Midjourney, Suno), default is `true` -- `GEMINI_VISION_MAX_IMAGE_NUM`: Maximum number of images for Gemini models, default is `16` -- `MAX_FILE_DOWNLOAD_MB`: Maximum file download size in MB, default is `20` -- `CRYPTO_SECRET`: Encryption key used for encrypting Redis database content -- `AZURE_DEFAULT_API_VERSION`: Azure channel default API version, default is `2025-04-01-preview` -- `NOTIFICATION_LIMIT_DURATION_MINUTE`: Notification limit duration, default is `10` minutes -- `NOTIFY_LIMIT_COUNT`: Maximum number of user notifications within the specified duration, default is `2` -- `ERROR_LOG_ENABLED=true`: Whether to record and display error logs, default is `false` - -## Deployment - -For detailed deployment guides, please refer to [Installation Guide-Deployment Methods](https://docs.newapi.pro/installation): - -> [!TIP] -> Latest Docker image: `calciumion/new-api:latest` - -### Multi-machine Deployment Considerations -- Environment variable `SESSION_SECRET` must be set, otherwise login status will be inconsistent across multiple machines -- If sharing Redis, `CRYPTO_SECRET` must be set, otherwise Redis content cannot be accessed across multiple machines - -### Deployment Requirements -- Local database (default): SQLite (Docker deployment must mount the `/data` directory) -- Remote database: MySQL version >= 5.7.8, PgSQL version >= 9.6 - -### Deployment Methods - -#### Using BaoTa Panel Docker Feature -Install BaoTa Panel (version **9.2.0** or above), find **New-API** in the application store and install it. -[Tutorial with images](./docs/BT.md) - -#### Using Docker Compose (Recommended) -```shell -# Download the project -git clone https://github.com/Calcium-Ion/new-api.git +```bash +# Clone the project +git clone https://github.com/QuantumNous/new-api.git cd new-api -# Edit docker-compose.yml as needed -# Start + +# Edit docker-compose.yml configuration +nano docker-compose.yml + +# Start the service docker-compose up -d ``` -#### Using Docker Image Directly -```shell -# Using SQLite -docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest +
+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 /home/ubuntu/data/new-api:/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 ``` -## Channel Retry and Cache -Channel retry functionality has been implemented, you can set the number of retries in `Settings->Operation Settings->General Settings->Failure Retry Count`, **recommended to enable caching** functionality. +> **💡 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` -### Cache Configuration Method -1. `REDIS_CONN_STRING`: Set Redis as cache -2. `MEMORY_CACHE_ENABLED`: Enable memory cache (no need to set manually if Redis is set) +
-## API Documentation +--- -For detailed API documentation, please refer to [API Documentation](https://docs.newapi.pro/api): +🎉 After deployment is complete, visit `http://localhost:3000` to start using! -- [Chat API (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [Response API (Responses)](https://docs.newapi.pro/api/openai-responses) -- [Image API (Image)](https://docs.newapi.pro/api/openai-image) -- [Rerank API (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [Realtime Chat API (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [Claude Chat API](https://docs.newapi.pro/api/anthropic-chat) -- [Google Gemini Chat API](https://docs.newapi.pro/api/google-gemini-chat) +📖 For more deployment methods, please refer to [Deployment Guide](https://docs.newapi.pro/installation) -## Related Projects -- [One API](https://github.com/songquanpeng/one-api): Original project -- [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy): Midjourney interface support -- [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool): Query usage quota with key +--- -Other projects based on New API: -- [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon): High-performance optimized version of New API +## 📚 Documentation -## Help and Support +
-If you have any questions, please refer to [Help and Support](https://docs.newapi.pro/support): -- [Community Interaction](https://docs.newapi.pro/support/community-interaction) -- [Issue Feedback](https://docs.newapi.pro/support/feedback-issues) -- [FAQ](https://docs.newapi.pro/support/faq) +### 📖 [Official Documentation](https://docs.newapi.pro/) | [![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/installation) | +| ⚙️ Environment Configuration | [Environment Variables](https://docs.newapi.pro/installation/environment-variables) | +| 📡 API Documentation | [API Documentation](https://docs.newapi.pro/api) | +| ❓ FAQ | [FAQ](https://docs.newapi.pro/support/faq) | +| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/support/community-interaction) | + +--- + +## ✨ Key Features + +> For detailed features, please refer to [Features Introduction](https://docs.newapi.pro/wiki/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 + +- 🤖 LinuxDO authorization login +- 📱 Telegram authorization login +- 🔑 OIDC unified authentication + +### 🚀 Advanced Features + +**API Format Support:** +- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) (including Azure) +- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) +- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) +- 🔄 [Rerank Models](https://docs.newapi.pro/api/jinaai-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 + +
+ +--- + +## 🤖 Model Support + +> For details, please refer to [API Documentation - Relay Interface](https://docs.newapi.pro/api) + +| Model Type | Description | Documentation | +|---------|------|------| +| 🤖 OpenAI GPTs | gpt-4-gizmo-* series | - | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/api/midjourney-proxy-image) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/api/suno-music) | +| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/api/jinaai-rerank) | +| 💬 Claude | Messages format | [Documentation](https://docs.newapi.pro/api/anthropic-chat) | +| 🌐 Gemini | Google Gemini format | [Documentation](https://docs.newapi.pro/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/api/openai-chat) +- [Response Interface (Responses)](https://docs.newapi.pro/api/openai-responses) +- [Image Interface (Image)](https://docs.newapi.pro/api/openai-image) +- [Audio Interface (Audio)](https://docs.newapi.pro/api/openai-audio) +- [Video Interface (Video)](https://docs.newapi.pro/api/openai-video) +- [Embedding Interface (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) +- [Rerank Interface (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) +- [Realtime Conversation (Realtime)](https://docs.newapi.pro/api/openai-realtime) +- [Claude Chat](https://docs.newapi.pro/api/anthropic-chat) +- [Google Gemini Chat](https://docs.newapi.pro/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` | +| `AZURE_DEFAULT_API_VERSION` | Azure API version | `2025-04-01-preview` | +| `ERROR_LOG_ENABLED` | Error log switch | `false` | + +📖 **Complete configuration:** [Environment Variables Documentation](https://docs.newapi.pro/installation/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/support/faq) | +| 💬 Community Interaction | [Communication Channels](https://docs.newapi.pro/support/community-interaction) | +| 🐛 Issue Feedback | [Issue Feedback](https://docs.newapi.pro/support/feedback-issues) | +| 📚 Complete Documentation | [Official Documentation](https://docs.newapi.pro/support) | + +### 🤝 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/)** • **[Issue Feedback](https://github.com/Calcium-Ion/new-api/issues)** • **[Latest Release](https://github.com/Calcium-Ion/new-api/releases)** + +Built with ❤️ by QuantumNous + +
diff --git a/README.fr.md b/README.fr.md index b308660cf..a941c50db 100644 --- a/README.fr.md +++ b/README.fr.md @@ -1,19 +1,17 @@ -

- 中文 | English | Français | 日本語 -

- -> [!NOTE] -> **MT (Traduction Automatique)**: Ce document est traduit automatiquement. Pour les informations les plus précises, veuillez vous référer à la [version chinoise](./README.md). -
![new-api](/web/public/logo.png) # New API -🍥 Passerelle de modèles étendus de nouvelle génération et système de gestion d'actifs d'IA +🍥 **Passerelle de modèles étendus de nouvelle génération et système de gestion d'actifs d'IA** -Calcium-Ion%2Fnew-api | Trendshift +

+ 中文 | + English | + Français | + 日本語 +

@@ -32,194 +30,412 @@ GoReportCard

+ +

+ + Calcium-Ion%2Fnew-api | Trendshift + +

+ +

+ Démarrage rapide • + Fonctionnalités clés • + Déploiement • + Documentation • + Aide +

+
## 📝 Description du projet -> [!NOTE] +> [!NOTE] > Il s'agit d'un projet open-source développé sur la base de [One API](https://github.com/songquanpeng/one-api) -> [!IMPORTANT] +> [!IMPORTANT] > - Ce projet est uniquement destiné à des fins d'apprentissage personnel, sans garantie de stabilité ni de support technique. > - Les utilisateurs doivent se conformer aux [Conditions d'utilisation](https://openai.com/policies/terms-of-use) d'OpenAI et aux **lois et réglementations applicables**, et ne doivent pas l'utiliser à des fins illégales. > - Conformément aux [《Mesures provisoires pour la gestion des services d'intelligence artificielle générative》](http://www.cac.gov.cn/2023-07/13/c_1690898327029107.htm), veuillez ne fournir aucun service d'IA générative non enregistré au public en Chine. -

🤝 Partenaires de confiance

-

 

-

Sans ordre particulier

+--- + +## 🤝 Partenaires de confiance +

- Cherry Studio - Université de Pékin - UCloud - Alibaba Cloud - IO.NET + Sans ordre particulier

-

 

-## 📚 Documentation +

+ + Cherry Studio + + + Université de Pékin + + + UCloud + + + Alibaba Cloud + + + IO.NET + +

-Pour une documentation détaillée, veuillez consulter notre Wiki officiel : [https://docs.newapi.pro/](https://docs.newapi.pro/) +--- -Vous pouvez également accéder au DeepWiki généré par l'IA : -[![Demander à DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +## 🙏 Remerciements spéciaux -## ✨ Fonctionnalités clés +

+ + JetBrains Logo + +

-New API offre un large éventail de fonctionnalités, veuillez vous référer à [Présentation des fonctionnalités](https://docs.newapi.pro/wiki/features-introduction) pour plus de détails : +

+ Merci à JetBrains pour avoir fourni une licence de développement open-source gratuite pour ce projet +

-1. 🎨 Nouvelle interface utilisateur -2. 🌍 Prise en charge multilingue -3. 💰 Fonctionnalité de recharge en ligne, prend actuellement en charge EPay et Stripe -4. 🔍 Prise en charge de la recherche de quotas d'utilisation avec des clés (fonctionne avec [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)) -5. 🔄 Compatible avec la base de données originale de One API -6. 💵 Prise en charge de la tarification des modèles de paiement à l'utilisation -7. ⚖️ Prise en charge de la sélection aléatoire pondérée des canaux -8. 📈 Tableau de bord des données (console) -9. 🔒 Regroupement de jetons et restrictions de modèles -10. 🤖 Prise en charge de plus de méthodes de connexion par autorisation (LinuxDO, Telegram, OIDC) -11. 🔄 Prise en charge des modèles Rerank (Cohere et Jina), [Documentation de l'API](https://docs.newapi.pro/api/jinaai-rerank) -12. ⚡ Prise en charge de l'API OpenAI Realtime (y compris les canaux Azure), [Documentation de l'API](https://docs.newapi.pro/api/openai-realtime) -13. ⚡ Prise en charge du format **OpenAI Responses**, [Documentation de l'API](https://docs.newapi.pro/api/openai-responses) -14. ⚡ Prise en charge du format **Claude Messages**, [Documentation de l'API](https://docs.newapi.pro/api/anthropic-chat) -15. ⚡ Prise en charge du format **Google Gemini**, [Documentation de l'API](https://docs.newapi.pro/api/google-gemini-chat/) -16. 🧠 Prise en charge de la définition de l'effort de raisonnement via les suffixes de nom de modèle : - 1. Modèles de la série o d'OpenAI - - Ajouter le suffixe `-high` pour un effort de raisonnement élevé (par exemple : `o3-mini-high`) - - Ajouter le suffixe `-medium` pour un effort de raisonnement moyen (par exemple : `o3-mini-medium`) - - Ajouter le suffixe `-low` pour un effort de raisonnement faible (par exemple : `o3-mini-low`) - 2. Modèles de pensée de Claude - - Ajouter le suffixe `-thinking` pour activer le mode de pensée (par exemple : `claude-3-7-sonnet-20250219-thinking`) -17. 🔄 Fonctionnalité de la pensée au contenu -18. 🔄 Limitation du débit du modèle pour les utilisateurs -19. 🔄 Fonctionnalité de conversion de format de requête, prenant en charge les trois conversions de format suivantes : - 1. OpenAI Chat Completions => Claude Messages - 2. Claude Messages => OpenAI Chat Completions (peut être utilisé pour Claude Code pour appeler des modèles tiers) - 3. OpenAI Chat Completions => Gemini Chat -20. 💰 Prise en charge de la facturation du cache, qui permet de facturer à un ratio défini lorsque le cache est atteint : - 1. Définir l'option `Ratio de cache d'invite` dans `Paramètres système->Paramètres de fonctionnement` - 2. Définir le `Ratio de cache d'invite` dans le canal, plage de 0 à 1, par exemple, le définir sur 0,5 signifie facturer à 50 % lorsque le cache est atteint - 3. Canaux pris en charge : - - [x] OpenAI - - [x] Azure - - [x] DeepSeek - - [x] Claude +--- -## Prise en charge des modèles +## 🚀 Démarrage rapide -Cette version prend en charge plusieurs modèles, veuillez vous référer à [Documentation de l'API-Interface de relais](https://docs.newapi.pro/api) pour plus de détails : +### Utilisation de Docker Compose (recommandé) -1. Modèles tiers **gpts** (gpt-4-gizmo-*) -2. Canal tiers [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy), [Documentation de l'API](https://docs.newapi.pro/api/midjourney-proxy-image) -3. Canal tiers [Suno API](https://github.com/Suno-API/Suno-API), [Documentation de l'API](https://docs.newapi.pro/api/suno-music) -4. Canaux personnalisés, prenant en charge la saisie complète de l'adresse d'appel -5. Modèles Rerank ([Cohere](https://cohere.ai/) et [Jina](https://jina.ai/)), [Documentation de l'API](https://docs.newapi.pro/api/jinaai-rerank) -6. Format de messages Claude, [Documentation de l'API](https://docs.newapi.pro/api/anthropic-chat) -7. Format Google Gemini, [Documentation de l'API](https://docs.newapi.pro/api/google-gemini-chat/) -8. Dify, ne prend actuellement en charge que chatflow -9. Pour plus d'interfaces, veuillez vous référer à la [Documentation de l'API](https://docs.newapi.pro/api) - -## Configuration des variables d'environnement - -Pour des instructions de configuration détaillées, veuillez vous référer à [Guide d'installation-Configuration des variables d'environnement](https://docs.newapi.pro/installation/environment-variables) : - -- `GENERATE_DEFAULT_TOKEN` : S'il faut générer des jetons initiaux pour les utilisateurs nouvellement enregistrés, la valeur par défaut est `false` -- `STREAMING_TIMEOUT` : Délai d'expiration de la réponse en streaming, la valeur par défaut est de 300 secondes -- `DIFY_DEBUG` : S'il faut afficher les informations sur le flux de travail et les nœuds pour les canaux Dify, la valeur par défaut est `true` -- `GET_MEDIA_TOKEN` : S'il faut compter les jetons d'image, la valeur par défaut est `true` -- `GET_MEDIA_TOKEN_NOT_STREAM` : S'il faut compter les jetons d'image dans les cas sans streaming, la valeur par défaut est `true` -- `UPDATE_TASK` : S'il faut mettre à jour les tâches asynchrones (Midjourney, Suno), la valeur par défaut est `true` -- `GEMINI_VISION_MAX_IMAGE_NUM` : Nombre maximum d'images pour les modèles Gemini, la valeur par défaut est `16` -- `MAX_FILE_DOWNLOAD_MB` : Taille maximale de téléchargement de fichier en Mo, la valeur par défaut est `20` -- `CRYPTO_SECRET` : Clé de chiffrement utilisée pour chiffrer le contenu de la base de données Redis -- `AZURE_DEFAULT_API_VERSION` : Version de l'API par défaut du canal Azure, la valeur par défaut est `2025-04-01-preview` -- `NOTIFICATION_LIMIT_DURATION_MINUTE` : Durée de la limite de notification, la valeur par défaut est de `10` minutes -- `NOTIFY_LIMIT_COUNT` : Nombre maximal de notifications utilisateur dans la durée spécifiée, la valeur par défaut est `2` -- `ERROR_LOG_ENABLED=true` : S'il faut enregistrer et afficher les journaux d'erreurs, la valeur par défaut est `false` - -## Déploiement - -Pour des guides de déploiement détaillés, veuillez vous référer à [Guide d'installation-Méthodes de déploiement](https://docs.newapi.pro/installation) : - -> [!TIP] -> Dernière image Docker : `calciumion/new-api:latest` - -### Considérations sur le déploiement multi-machines -- La variable d'environnement `SESSION_SECRET` doit être définie, sinon l'état de connexion sera incohérent sur plusieurs machines -- Si vous partagez Redis, `CRYPTO_SECRET` doit être défini, sinon le contenu de Redis ne pourra pas être consulté sur plusieurs machines - -### Exigences de déploiement -- Base de données locale (par défaut) : SQLite (le déploiement Docker doit monter le répertoire `/data`) -- Base de données distante : MySQL version >= 5.7.8, PgSQL version >= 9.6 - -### Méthodes de déploiement - -#### Utilisation de la fonctionnalité Docker du panneau BaoTa -Installez le panneau BaoTa (version **9.2.0** ou supérieure), recherchez **New-API** dans le magasin d'applications et installez-le. -[Tutoriel avec des images](./docs/BT.md) - -#### Utilisation de Docker Compose (recommandé) -```shell -# Télécharger le projet -git clone https://github.com/Calcium-Ion/new-api.git +```bash +# Cloner le projet +git clone https://github.com/QuantumNous/new-api.git cd new-api -# Modifier docker-compose.yml si nécessaire -# Démarrer + +# Modifier la configuration docker-compose.yml +nano docker-compose.yml + +# Démarrer le service docker-compose up -d ``` -#### Utilisation directe de l'image Docker -```shell -# Utilisation de SQLite -docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest +
+Utilisation des commandes Docker + +```bash +# Tirer la dernière image +docker pull calciumion/new-api:latest + +# Utilisation de SQLite (par défaut) +docker run --name new-api -d --restart always \ + -p 3000:3000 \ + -e TZ=Asia/Shanghai \ + -v ./data:/data \ + calciumion/new-api:latest # Utilisation de 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 /home/ubuntu/data/new-api:/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 ``` -## Nouvelle tentative de canal et cache -La fonctionnalité de nouvelle tentative de canal a été implémentée, vous pouvez définir le nombre de tentatives dans `Paramètres->Paramètres de fonctionnement->Paramètres généraux->Nombre de tentatives en cas d'échec`, **recommandé d'activer la fonctionnalité de mise en cache**. +> **💡 Astuce:** `-v ./data:/data` sauvegardera les données dans le dossier `data` du répertoire actuel, vous pouvez également le changer en chemin absolu comme `-v /your/custom/path:/data` -### Méthode de configuration du cache -1. `REDIS_CONN_STRING` : Définir Redis comme cache -2. `MEMORY_CACHE_ENABLED` : Activer le cache mémoire (pas besoin de le définir manuellement si Redis est défini) +
-## Documentation de l'API +--- -Pour une documentation détaillée de l'API, veuillez vous référer à [Documentation de l'API](https://docs.newapi.pro/api) : +🎉 Après le déploiement, visitez `http://localhost:3000` pour commencer à utiliser! -- [API de discussion (Chat Completions)](https://docs.newapi.pro/api/openai-chat) -- [API de réponse (Responses)](https://docs.newapi.pro/api/openai-responses) -- [API d'image (Image)](https://docs.newapi.pro/api/openai-image) -- [API de rerank (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) -- [API de discussion en temps réel (Realtime)](https://docs.newapi.pro/api/openai-realtime) -- [API de discussion Claude](https://docs.newapi.pro/api/anthropic-chat) -- [API de discussion Google Gemini](https://docs.newapi.pro/api/google-gemini-chat) +📖 Pour plus de méthodes de déploiement, veuillez vous référer à [Guide de déploiement](https://docs.newapi.pro/installation) -## Projets connexes -- [One API](https://github.com/songquanpeng/one-api) : Projet original -- [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy) : Prise en charge de l'interface Midjourney -- [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool) : Interroger le quota d'utilisation avec une clé +--- -Autres projets basés sur New API : -- [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon) : Version optimisée hautes performances de New API +## 📚 Documentation -## Aide et support +
-Si vous avez des questions, veuillez vous référer à [Aide et support](https://docs.newapi.pro/support) : -- [Interaction avec la communauté](https://docs.newapi.pro/support/community-interaction) -- [Commentaires sur les problèmes](https://docs.newapi.pro/support/feedback-issues) -- [FAQ](https://docs.newapi.pro/support/faq) +### 📖 [Documentation officielle](https://docs.newapi.pro/) | [![Demander à DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) + +
+ +**Navigation rapide:** + +| Catégorie | Lien | +|------|------| +| 🚀 Guide de déploiement | [Documentation d'installation](https://docs.newapi.pro/installation) | +| ⚙️ Configuration de l'environnement | [Variables d'environnement](https://docs.newapi.pro/installation/environment-variables) | +| 📡 Documentation de l'API | [Documentation de l'API](https://docs.newapi.pro/api) | +| ❓ FAQ | [FAQ](https://docs.newapi.pro/support/faq) | +| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/support/community-interaction) | + +--- + +## ✨ Fonctionnalités clés + +> Pour les fonctionnalités détaillées, veuillez vous référer à [Présentation des fonctionnalités](https://docs.newapi.pro/wiki/features-introduction) | + +### 🎨 Fonctions principales + +| Fonctionnalité | Description | +|------|------| +| 🎨 Nouvelle interface utilisateur | Conception d'interface utilisateur moderne | +| 🌍 Multilingue | Prend en charge le chinois, l'anglais, le français, le japonais | +| 🔄 Compatibilité des données | Complètement compatible avec la base de données originale de One API | +| 📈 Tableau de bord des données | Console visuelle et analyse statistique | +| 🔒 Gestion des permissions | Regroupement de jetons, restrictions de modèles, gestion des utilisateurs | + +### 💰 Paiement et facturation + +- ✅ Recharge en ligne (EPay, Stripe) +- ✅ Tarification des modèles de paiement à l'utilisation +- ✅ Prise en charge de la facturation du cache (OpenAI, Azure, DeepSeek, Claude, Qwen et tous les modèles pris en charge) +- ✅ Configuration flexible des politiques de facturation + +### 🔐 Autorisation et sécurité + +- 🤖 Connexion par autorisation LinuxDO +- 📱 Connexion par autorisation Telegram +- 🔑 Authentification unifiée OIDC + +### 🚀 Fonctionnalités avancées + +**Prise en charge des formats d'API:** +- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) (y compris Azure) +- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) +- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) +- 🔄 [Modèles Rerank](https://docs.newapi.pro/api/jinaai-rerank) (Cohere, Jina) + +**Routage intelligent:** +- ⚖️ Sélection aléatoire pondérée des canaux +- 🔄 Nouvelle tentative automatique en cas d'échec +- 🚦 Limitation du débit du modèle pour les utilisateurs + +**Conversion de format:** +- 🔄 OpenAI ⇄ Claude Messages +- 🔄 OpenAI ⇄ Gemini Chat +- 🔄 Fonctionnalité de la pensée au contenu + +**Prise en charge de l'effort de raisonnement:** + +
+Voir la configuration détaillée + +**Modèles de la série o d'OpenAI:** +- `o3-mini-high` - Effort de raisonnement élevé +- `o3-mini-medium` - Effort de raisonnement moyen +- `o3-mini-low` - Effort de raisonnement faible + +**Modèles de pensée de Claude:** +- `claude-3-7-sonnet-20250219-thinking` - Activer le mode de pensée + +**Modèles de la série Google Gemini:** +- `gemini-2.5-flash-thinking` - Activer le mode de pensée +- `gemini-2.5-flash-nothinking` - Désactiver le mode de pensée +- `gemini-2.5-pro-thinking` - Activer le mode de pensée +- `gemini-2.5-pro-thinking-128` - Activer le mode de pensée avec budget de pensée de 128 tokens + +
+ +--- + +## 🤖 Prise en charge des modèles + +> Pour les détails, veuillez vous référer à [Documentation de l'API - Interface de relais](https://docs.newapi.pro/api) + +| Type de modèle | Description | Documentation | +|---------|------|------| +| 🤖 OpenAI GPTs | série gpt-4-gizmo-* | - | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [Documentation](https://docs.newapi.pro/api/midjourney-proxy-image) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [Documentation](https://docs.newapi.pro/api/suno-music) | +| 🔄 Rerank | Cohere, Jina | [Documentation](https://docs.newapi.pro/api/jinaai-rerank) | +| 💬 Claude | Format Messages | [Documentation](https://docs.newapi.pro/api/anthropic-chat) | +| 🌐 Gemini | Format Google Gemini | [Documentation](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🔧 Dify | Mode ChatFlow | - | +| 🎯 Personnalisé | Prise en charge de l'adresse d'appel complète | - | + +### 📡 Interfaces prises en charge + +
+Voir la liste complète des interfaces + +- [Interface de discussion (Chat Completions)](https://docs.newapi.pro/api/openai-chat) +- [Interface de réponse (Responses)](https://docs.newapi.pro/api/openai-responses) +- [Interface d'image (Image)](https://docs.newapi.pro/api/openai-image) +- [Interface audio (Audio)](https://docs.newapi.pro/api/openai-audio) +- [Interface vidéo (Video)](https://docs.newapi.pro/api/openai-video) +- [Interface d'incorporation (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) +- [Interface de rerank (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) +- [Conversation en temps réel (Realtime)](https://docs.newapi.pro/api/openai-realtime) +- [Discussion Claude](https://docs.newapi.pro/api/anthropic-chat) +- [Discussion Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) + +
+ +--- + +## 🚢 Déploiement + +> [!TIP] +> **Dernière image Docker:** `calciumion/new-api:latest` + +### 📋 Exigences de déploiement + +| Composant | Exigence | +|------|------| +| **Base de données locale** | SQLite (Docker doit monter le répertoire `/data`)| +| **Base de données distante | MySQL ≥ 5.7.8 ou PostgreSQL ≥ 9.6 | +| **Moteur de conteneur** | Docker / Docker Compose | + +### ⚙️ Configuration des variables d'environnement + +
+Configuration courante des variables d'environnement + +| Nom de variable | Description | Valeur par défaut | +|--------|------|--------| +| `SESSION_SECRET` | Secret de session (requis pour le déploiement multi-machines) | +| `CRYPTO_SECRET` | Secret de chiffrement (requis pour Redis) | - | +| `SQL_DSN` | Chaine de connexion à la base de données | - | +| `REDIS_CONN_STRING` | Chaine de connexion Redis | - | +| `STREAMING_TIMEOUT` | Délai d'expiration du streaming (secondes) | `300` | +| `AZURE_DEFAULT_API_VERSION` | Version de l'API Azure | `2025-04-01-preview` | +| `ERROR_LOG_ENABLED` | Interrupteur du journal d'erreurs | `false` | + +📖 **Configuration complète:** [Documentation des variables d'environnement](https://docs.newapi.pro/installation/environment-variables) + +
+ +### 🔧 Méthodes de déploiement + +
+Méthode 1: Docker Compose (recommandé) + +```bash +# Cloner le projet +git clone https://github.com/QuantumNous/new-api.git +cd new-api + +# Modifier la configuration +nano docker-compose.yml + +# Démarrer le service +docker-compose up -d +``` + +
+ +
+Méthode 2: Commandes Docker + +**Utilisation de SQLite:** +```bash +docker run --name new-api -d --restart always \ + -p 3000:3000 \ + -e TZ=Asia/Shanghai \ + -v ./data:/data \ + calciumion/new-api:latest +``` + +**Utilisation de 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 +``` + +> **💡 Explication du chemin:** +> - `./data:/data` - Chemin relatif, données sauvegardées dans le dossier data du répertoire actuel +> - Vous pouvez également utiliser un chemin absolu, par exemple : `/your/custom/path:/data` + +
+ +
+Méthode 3: Panneau BaoTa + +1. Installez le panneau BaoTa (version **9.2.0** ou supérieure), recherchez **New-API** dans le magasin d'applications et installez-le. +2. Recherchez **New-API** dans le magasin d'applications et installez-le. + +📖 [Tutoriel avec des images](./docs/BT.md) + +
+ +### ⚠️ Considérations sur le déploiement multi-machines + +> [!WARNING] +> - **Doit définir** `SESSION_SECRET` - Sinon l'état de connexion sera incohérent sur plusieurs machines +> - **Redis partagé doit définir** `CRYPTO_SECRET` - Sinon les données ne pourront pas être déchiffrées + +### 🔄 Nouvelle tentative de canal et cache + +**Configuration de la nouvelle tentative:** `Paramètres → Paramètres de fonctionnement → Paramètres généraux → Nombre de tentatives en cas d'échec` + +**Configuration du cache:** +- `REDIS_CONN_STRING`: Cache Redis (recommandé) +- `MEMORY_CACHE_ENABLED`: Cache mémoire + +--- + +## 🔗 Projets connexes + +### Projets en amont + +| Projet | Description | +|------|------| +| [One API](https://github.com/songquanpeng/one-api) | Base du projet original | +| [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy) | Prise en charge de l'interface Midjourney | + +### Outils d'accompagnement + +| Projet | Description | +|------|------| +| [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool) | Outil de recherche de quota d'utilisation avec une clé | + +--- + +## 💬 Aide et support + +### 📖 Ressources de documentation + +| Ressource | Lien | +|------|------| +| 📘 FAQ | [FAQ](https://docs.newapi.pro/support/faq) | +| 💬 Interaction avec la communauté | [Canaux de communication](https://docs.newapi.pro/support/community-interaction) | +| 🐛 Commentaires sur les problèmes | [Commentaires sur les problèmes](https://docs.newapi.pro/support/feedback-issues) | +| 📚 Documentation complète | [Documentation officielle](https://docs.newapi.pro/support) | + +### 🤝 Guide de contribution + +Bienvenue à toutes les formes de contribution! + +- 🐛 Signaler des bogues +- 💡 Proposer de nouvelles fonctionnalités +- 📝 Améliorer la documentation +- 🔧 Soumettre du code + +--- ## 🌟 Historique des étoiles -[![Graphique de l'historique des étoiles](https://api.star-history.com/svg?repos=Calcium-Ion/new-api&type=Date)](https://star-history.com/#Calcium-Ion/new-api&Date) \ No newline at end of file +
+ +[![Graphique de l'historique des étoiles](https://api.star-history.com/svg?repos=Calcium-Ion/new-api&type=Date)](https://star-history.com/#Calcium-Ion/new-api&Date) + +
+ +--- + +
+ +### 💖 Merci d'utiliser New API + +Si ce projet vous est utile, bienvenue à nous donner une ⭐️ Étoile！ + +**[Documentation officielle](https://docs.newapi.pro/)** • **[Commentaires sur les problèmes](https://github.com/Calcium-Ion/new-api/issues)** • **[Dernière version](https://github.com/Calcium-Ion/new-api/releases)** + +Construit avec ❤️ par QuantumNous + +
\ No newline at end of file diff --git a/README.ja.md b/README.ja.md index 315518c91..928e190f5 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,19 +1,17 @@ -

- 中文 | English | Français | 日本語 -

- -> [!NOTE] -> **MT（機械翻訳）**: この文書は機械翻訳されています。最も正確な情報については、[中国語版](./README.md)を参照してください。 -
![new-api](/web/public/logo.png) # New API -🍥次世代大規模モデルゲートウェイとAI資産管理システム +🍥 **次世代大規模モデルゲートウェイとAI資産管理システム** -Calcium-Ion%2Fnew-api | Trendshift +

+ 中文 | + English | + Français | + 日本語 +

@@ -32,6 +30,21 @@ GoReportCard

+ +

+ + Calcium-Ion%2Fnew-api | Trendshift + +

+ +

+ クイックスタート • + 主な機能 • + デプロイ • + ドキュメント • + ヘルプ +

+
## 📝 プロジェクト説明 @@ -44,183 +57,394 @@ > - ユーザーは、OpenAIの[利用規約](https://openai.com/policies/terms-of-use)および**法律法規**を遵守する必要があり、違法な目的で使用してはいけません。 > - [《生成式人工智能服务管理暂行办法》](http://www.cac.gov.cn/2023-07/13/c_1690898327029107.htm)の要求に従い、中国地域の公衆に未登録の生成式AI サービスを提供しないでください。 -

🤝 信頼できるパートナー

-

 

-

順不同

+--- + +## 🤝 信頼できるパートナー +

- Cherry Studio - 北京大学 - UCloud 優刻得 - Alibaba Cloud - IO.NET + 順不同

-

 

-## 📚 ドキュメント +

+ + Cherry Studio + + + 北京大学 + + + UCloud 優刻得 + + + Alibaba Cloud + + + IO.NET + +

-詳細なドキュメントは公式Wikiをご覧ください：[https://docs.newapi.pro/](https://docs.newapi.pro/) +--- -AIが生成したDeepWikiにもアクセスできます： -[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) +## 🙏 特別な感謝 -## ✨ 主な機能 +

+ + JetBrains Logo + +

-New APIは豊富な機能を提供しています。詳細な機能については[機能説明](https://docs.newapi.pro/wiki/features-introduction)を参照してください： +

+ 感謝 JetBrains が本プロジェクトに無料のオープンソース開発ライセンスを提供してくれたことに感謝します +

-1. 🎨 全く新しいUIインターフェース -2. 🌍 多言語サポート -3. 💰 オンラインチャージ機能をサポート、現在EPayとStripeをサポート -4. 🔍 キーによる使用量クォータの照会をサポート（[neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)と連携） -5. 🔄 オリジナルのOne APIデータベースと互換性あり -6. 💵 モデルの従量課金をサポート -7. ⚖️ チャネルの重み付けランダムをサポート -8. 📈 データダッシュボード（コンソール） -9. 🔒 トークングループ化、モデル制限 -10. 🤖 より多くの認証ログイン方法をサポート（LinuxDO、Telegram、OIDC） -11. 🔄 Rerankモデルをサポート（CohereとJina）、[API ドキュメント](https://docs.newapi.pro/api/jinaai-rerank) -12. ⚡ OpenAI Realtime APIをサポート（Azureチャネルを含む）、[APIドキュメント](https://docs.newapi.pro/api/openai-realtime) -13. ⚡ **OpenAI Responses**形式をサポート、[APIドキュメント](https://docs.newapi.pro/api/openai-responses) -14. ⚡ **Claude Messages**形式をサポート、[APIドキュメント](https://docs.newapi.pro/api/anthropic-chat) -15. ⚡ **Google Gemini**形式をサポート、[APIドキュメント](https://docs.newapi.pro/api/google-gemini-chat/) -16. 🧠 モデル名のサフィックスを通じてreasoning effortを設定することをサポート： - 1. OpenAI oシリーズモデル - - `-high`サフィックスを追加してhigh reasoning effortに設定（例：`o3-mini-high`） - - `-medium`サフィックスを追加してmedium reasoning effortに設定（例：`o3-mini-medium`） - - `-low`サフィックスを追加してlow reasoning effortに設定（例：`o3-mini-low`） - 2. Claude思考モデル - - `-thinking`サフィックスを追加して思考モードを有効にする（例：`claude-3-7-sonnet-20250219-thinking`） -17. 🔄 思考からコンテンツへの機能 -18. 🔄 ユーザーに対するモデルレート制限機能 -19. 🔄 リクエストフォーマット変換機能、以下の3つのフォーマット変換をサポート： - 1. OpenAI Chat Completions => Claude Messages - 2. Claude Messages => OpenAI Chat Completions（Claude Codeがサードパーティモデルを呼び出す際に使用可能） - 3. OpenAI Chat Completions => Gemini Chat -20. 💰 キャッシュ課金サポート、有効にするとキャッシュがヒットした際に設定された比率で課金できます： - 1. `システム設定-運営設定`で`プロンプトキャッシュ倍率`オプションを設定 - 2. チャネルで`プロンプトキャッシュ倍率`を設定、範囲は0-1、例えば0.5に設定するとキャッシュがヒットした際に50%で課金 - 3. サポートされているチャネル： - - [x] OpenAI - - [x] Azure - - [x] DeepSeek - - [x] Claude +--- -## モデルサポート +## 🚀 クイックスタート -このバージョンは複数のモデルをサポートしています。詳細は[APIドキュメント-中継インターフェース](https://docs.newapi.pro/api)を参照してください： +### Docker Composeを使用（推奨） -1. サードパーティモデル **gpts**（gpt-4-gizmo-*） -2. サードパーティチャネル[Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy)インターフェース、[APIドキュメント](https://docs.newapi.pro/api/midjourney-proxy-image) -3. サードパーティチャネル[Suno API](https://github.com/Suno-API/Suno-API)インターフェース、[APIドキュメント](https://docs.newapi.pro/api/suno-music) -4. カスタムチャネル、完全な呼び出しアドレスの入力をサポート -5. Rerankモデル（[Cohere](https://cohere.ai/)と[Jina](https://jina.ai/)）、[APIドキュメント](https://docs.newapi.pro/api/jinaai-rerank) -6. Claude Messages形式、[APIドキュメント](https://docs.newapi.pro/api/anthropic-chat) -7. Google Gemini形式、[APIドキュメント](https://docs.newapi.pro/api/google-gemini-chat/) -8. Dify、現在はchatflowのみをサポート -9. その他のインターフェースについては[APIドキュメント](https://docs.newapi.pro/api)を参照してください - -## 環境変数設定 - -詳細な設定説明については[インストールガイド-環境変数設定](https://docs.newapi.pro/installation/environment-variables)を参照してください： - -- `GENERATE_DEFAULT_TOKEN`：新規登録ユーザーに初期トークンを生成するかどうか、デフォルトは`false` -- `STREAMING_TIMEOUT`：ストリーミング応答のタイムアウト時間、デフォルトは300秒 -- `DIFY_DEBUG`：Difyチャネルがワークフローとノード情報を出力するかどうか、デフォルトは`true` -- `GET_MEDIA_TOKEN`：画像トークンを統計するかどうか、デフォルトは`true` -- `GET_MEDIA_TOKEN_NOT_STREAM`：非ストリーミングの場合に画像トークンを統計するかどうか、デフォルトは`true` -- `UPDATE_TASK`：非同期タスク（Midjourney、Suno）を更新するかどうか、デフォルトは`true` -- `GEMINI_VISION_MAX_IMAGE_NUM`：Geminiモデルの最大画像数、デフォルトは`16` -- `MAX_FILE_DOWNLOAD_MB`: 最大ファイルダウンロードサイズ、単位MB、デフォルトは`20` -- `CRYPTO_SECRET`：暗号化キー、Redisデータベースの内容を暗号化するために使用 -- `AZURE_DEFAULT_API_VERSION`：Azureチャネルのデフォルトのバージョン、デフォルトは`2025-04-01-preview` -- `NOTIFICATION_LIMIT_DURATION_MINUTE`：メールなどの通知制限の継続時間、デフォルトは`10`分 -- `NOTIFY_LIMIT_COUNT`：指定された継続時間内のユーザー通知の最大数、デフォルトは`2` -- `ERROR_LOG_ENABLED=true`: エラーログを記録して表示するかどうか、デフォルトは`false` - -## デプロイ - -詳細なデプロイガイドについては[インストールガイド-デプロイ方法](https://docs.newapi.pro/installation)を参照してください： - -> [!TIP] -> 最新のDockerイメージ：`calciumion/new-api:latest` - -### マルチマシンデプロイの注意事項 -- 環境変数`SESSION_SECRET`を設定する必要があります。そうしないとマルチマシンデプロイ時にログイン状態が不一致になります -- Redisを共有する場合、`CRYPTO_SECRET`を設定する必要があります。そうしないとマルチマシンデプロイ時にRedisの内容を取得できません - -### デプロイ要件 -- ローカルデータベース（デフォルト）：SQLite（Dockerデプロイの場合は`/data`ディレクトリをマウントする必要があります） -- リモートデータベース：MySQLバージョン >= 5.7.8、PgSQLバージョン >= 9.6 - -### デプロイ方法 - -#### 宝塔パネルのDocker機能を使用してデプロイ -宝塔パネル（**9.2.0バージョン**以上）をインストールし、アプリケーションストアで**New-API**を見つけてインストールします。 -[画像付きチュートリアル](./docs/BT.md) - -#### Docker Composeを使用してデプロイ（推奨） -```shell -# プロジェクトをダウンロード -git clone https://github.com/Calcium-Ion/new-api.git +```bash +# プロジェクトをクローン +git clone https://github.com/QuantumNous/new-api.git cd new-api -# 必要に応じてdocker-compose.ymlを編集 -# 起動 + +# docker-compose.yml 設定を編集 +nano docker-compose.yml + +# サービスを起動 docker-compose up -d ``` -#### Dockerイメージを直接使用 -```shell -# SQLiteを使用 -docker run --name new-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/new-api:/data calciumion/new-api:latest +
+Dockerコマンドを使用 + +```bash +# 最新のイメージをプル +docker pull calciumion/new-api:latest + +# SQLiteを使用（デフォルト） +docker run --name new-api -d --restart always \ + -p 3000:3000 \ + -e TZ=Asia/Shanghai \ + -v ./data:/data \ + calciumion/new-api:latest # 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 /home/ubuntu/data/new-api:/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 ``` -## チャネルリトライとキャッシュ -チャネルリトライ機能はすでに実装されており、`設定->運営設定->一般設定->失敗リトライ回数`でリトライ回数を設定できます。**キャッシュ機能を有効にすることを推奨します**。 +> **💡 ヒント:** `-v ./data:/data` は現在のディレクトリの `data` フォルダにデータを保存します。絶対パスに変更することもできます：`-v /your/custom/path:/data` -### キャッシュ設定方法 -1. `REDIS_CONN_STRING`：Redisをキャッシュとして設定 -2. `MEMORY_CACHE_ENABLED`：メモリキャッシュを有効にする（Redisを設定した場合は手動設定不要） +
-## APIドキュメント +--- -詳細なAPIドキュメントについては[APIドキュメント](https://docs.newapi.pro/api)を参照してください： +🎉 デプロイが完了したら、`http://localhost:3000` にアクセスして使用を開始してください！ -- [チャットインターフェース（Chat Completions）](https://docs.newapi.pro/api/openai-chat) -- [レスポンスインターフェース（Responses）](https://docs.newapi.pro/api/openai-responses) -- [画像インターフェース（Image）](https://docs.newapi.pro/api/openai-image) -- [再ランク付けインターフェース（Rerank）](https://docs.newapi.pro/api/jinaai-rerank) -- [リアルタイム対話インターフェース（Realtime）](https://docs.newapi.pro/api/openai-realtime) -- [Claudeチャットインターフェース](https://docs.newapi.pro/api/anthropic-chat) -- [Google Geminiチャットインターフェース](https://docs.newapi.pro/api/google-gemini-chat) +📖 その他のデプロイ方法については[デプロイガイド](https://docs.newapi.pro/installation)を参照してください。 -## 関連プロジェクト -- [One API](https://github.com/songquanpeng/one-api)：オリジナルプロジェクト -- [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy)：Midjourneyインターフェースサポート -- [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool)：キーを使用して使用量クォータを照会 +--- -New APIベースのその他のプロジェクト： -- [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon)：New API高性能最適化版 +## 📚 ドキュメント -## ヘルプサポート +
-問題がある場合は、[ヘルプサポート](https://docs.newapi.pro/support)を参照してください： -- [コミュニティ交流](https://docs.newapi.pro/support/community-interaction) -- [問題のフィードバック](https://docs.newapi.pro/support/feedback-issues) -- [よくある質問](https://docs.newapi.pro/support/faq) +### 📖 [公式ドキュメント](https://docs.newapi.pro/) | [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/QuantumNous/new-api) -## 🌟 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) +**クイックナビゲーション:** +| カテゴリ | リンク | +|------|------| +| 🚀 デプロイガイド | [インストールドキュメント](https://docs.newapi.pro/installation) | +| ⚙️ 環境設定 | [環境変数](https://docs.newapi.pro/installation/environment-variables) | +| 📡 APIドキュメント | [APIドキュメント](https://docs.newapi.pro/api) | +| ❓ よくある質問 | [FAQ](https://docs.newapi.pro/support/faq) | +| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/support/community-interaction) | + +--- + +## ✨ 主な機能 + +> 詳細な機能については[機能説明](https://docs.newapi.pro/wiki/features-introduction)を参照してください。 + +### 🎨 コア機能 + +| 機能 | 説明 | +|------|------| +| 🎨 新しいUI | モダンなユーザーインターフェースデザイン | +| 🌍 多言語 | 中国語、英語、フランス語、日本語をサポート | +| 🔄 データ互換性 | オリジナルのOne APIデータベースと完全に互換性あり | +| 📈 データダッシュボード | ビジュアルコンソールと統計分析 | +| 🔒 権限管理 | トークングループ化、モデル制限、ユーザー管理 | + +### 💰 支払いと課金 + +- ✅ オンライン充電（EPay、Stripe） +- ✅ モデルの従量課金 +- ✅ キャッシュ課金サポート（OpenAI、Azure、DeepSeek、Claude、Qwenなどすべてのサポートされているモデル） +- ✅ 柔軟な課金ポリシー設定 + +### 🔐 認証とセキュリティ + +- 🤖 LinuxDO認証ログイン +- 📱 Telegram認証ログイン +- 🔑 OIDC統一認証 + + + +### 🚀 高度な機能 + +**APIフォーマットサポート:** +- ⚡ [OpenAI Responses](https://docs.newapi.pro/api/openai-responses) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime)（Azureを含む） +- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) +- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) +- 🔄 [Rerankモデル](https://docs.newapi.pro/api/jinaai-rerank) +- ⚡ [OpenAI Realtime API](https://docs.newapi.pro/api/openai-realtime) +- ⚡ [Claude Messages](https://docs.newapi.pro/api/anthropic-chat) +- ⚡ [Google Gemini](https://docs.newapi.pro/api/google-gemini-chat/) +- 🔄 [Rerankモデル](https://docs.newapi.pro/api/jinaai-rerank)（Cohere、Jina） + +**インテリジェントルーティング:** +- ⚖️ チャネル重み付けランダム +- 🔄 失敗自動リトライ +- 🚦 ユーザーレベルモデルレート制限 + +**フォーマット変換:** +- 🔄 OpenAI ⇄ Claude Messages +- 🔄 OpenAI ⇄ Gemini Chat +- 🔄 思考からコンテンツへの機能 + +**Reasoning Effort サポート:** + +
+詳細設定を表示 + +**OpenAIシリーズモデル:** +- `o3-mini-high` - 高思考努力 +- `o3-mini-medium` - 中思考努力 +- `o3-mini-low` - 低思考努力 +- `gpt-5-high` - 高思考努力 +- `gpt-5-medium` - 中思考努力 +- `gpt-5-low` - 低思考努力 + +**Claude思考モデル:** +- `claude-3-7-sonnet-20250219-thinking` - 思考モードを有効にする + +**Google Geminiシリーズモデル:** +- `gemini-2.5-flash-thinking` - 思考モードを有効にする +- `gemini-2.5-flash-nothinking` - 思考モードを無効にする +- `gemini-2.5-pro-thinking` - 思考モードを有効にする +- `gemini-2.5-pro-thinking-128` - 思考モードを有効にし、思考予算を128トークンに設定する + +
+ +--- + +## 🤖 モデルサポート + +> 詳細については[APIドキュメント - 中継インターフェース](https://docs.newapi.pro/api) + +| モデルタイプ | 説明 | ドキュメント | +|---------|------|------| +| 🤖 OpenAI GPTs | gpt-4-gizmo-* シリーズ | - | +| 🎨 Midjourney-Proxy | [Midjourney-Proxy(Plus)](https://github.com/novicezk/midjourney-proxy) | [ドキュメント](https://docs.newapi.pro/api/midjourney-proxy-image) | +| 🎵 Suno-API | [Suno API](https://github.com/Suno-API/Suno-API) | [ドキュメント](https://docs.newapi.pro/api/suno-music) | +| 🔄 Rerank | Cohere、Jina | [ドキュメント](https://docs.newapi.pro/api/jinaai-rerank) | +| 💬 Claude | Messagesフォーマット | [ドキュメント](https://docs.newapi.pro/api/suno-music) | +| 🌐 Gemini | Google Geminiフォーマット | [ドキュメント](https://docs.newapi.pro/api/google-gemini-chat/) | +| 🔧 Dify | ChatFlowモード | - | +| 🎯 カスタム | 完全な呼び出しアドレスの入力をサポート | - | + +### 📡 サポートされているインターフェース + +
+完全なインターフェースリストを表示 + +- [チャットインターフェース (Chat Completions)](https://docs.newapi.pro/api/openai-chat) +- [レスポンスインターフェース (Responses)](https://docs.newapi.pro/api/openai-responses) +- [イメージインターフェース (Image)](https://docs.newapi.pro/api/openai-image) +- [オーディオインターフェース (Audio)](https://docs.newapi.pro/api/openai-audio) +- [ビデオインターフェース (Video)](https://docs.newapi.pro/api/openai-video) +- [エンベッドインターフェース (Embeddings)](https://docs.newapi.pro/api/openai-embeddings) +- [再ランク付けインターフェース (Rerank)](https://docs.newapi.pro/api/jinaai-rerank) +- [リアルタイム対話インターフェース (Realtime)](https://docs.newapi.pro/api/openai-realtime) +- [Claudeチャット](https://docs.newapi.pro/api/anthropic-chat) +- [Google Geminiチャット](https://docs.newapi.pro/api/google-gemini-chat/) + +
+ +--- + +## 🚢 デプロイ + +> [!TIP] +> **最新のDockerイメージ:** `calciumion/new-api:latest` + +### 📋 デプロイ要件 + +| コンポーネント | 要件 | +|------|------| +| **ローカルデータベース** | SQLite（Dockerは `/data` ディレクトリをマウントする必要があります）| +| **リモートデータベース** | MySQL ≥ 5.7.8 または PostgreSQL ≥ 9.6 | +| **コンテナエンジン** | Docker / Docker Compose | + +### ⚙️ 環境変数設定 + +
+一般的な環境変数設定 + +| 変数名 | 説明 | デフォルト値 | +|--------|------|--------| +| `SESSION_SECRET` | セッションシークレット（マルチマシンデプロイに必須） | - | +| `CRYPTO_SECRET` | 暗号化シークレット（Redisに必須） | - | +| `SQL_DSN** | データベース接続文字列 | - | +| `REDIS_CONN_STRING` | Redis接続文字列 | - | +| `STREAMING_TIMEOUT` | ストリーミング応答のタイムアウト時間（秒） | `300` | +| `AZURE_DEFAULT_API_VERSION` | Azure APIバージョン | `2025-04-01-preview` | +| `ERROR_LOG_ENABLED` | エラーログスイッチ | `false` | + +📖 **完全な設定:** [環境変数ドキュメント](https://docs.newapi.pro/installation/environment-variables) + +
+ +### 🔧 デプロイ方法 + +
+方法 1: Docker Compose（推奨） + +```bash +# プロジェクトをクローン +git clone https://github.com/QuantumNous/new-api.git +cd new-api + +# 設定を編集 +nano docker-compose.yml + +# サービスを起動 +docker-compose up -d +``` + +
+ +
+方法 2: Dockerコマンド + +**SQLiteを使用:** +```bash +docker run --name new-api -d --restart always \ + -p 3000:3000 \ + -e TZ=Asia/Shanghai \ + -v ./data:/data \ + calciumion/new-api:latest +``` + +**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 +``` + +> **💡 パス説明:** +> - `./data:/data` - 相対パス、データは現在のディレクトリのdataフォルダに保存されます +> - 絶対パスを使用することもできます：`/your/custom/path:/data` + +
+ +
+方法 3: 宝塔パネル + +1. 宝塔パネル（**9.2.0バージョン**以上）をインストールし、アプリケーションストアで**New-API**を検索してインストールします。 + +📖 [画像付きチュートリアル](./docs/BT.md) + +
+ +### ⚠️ マルチマシンデプロイの注意事項 + +> [!WARNING] +> - **必ず設定する必要があります** `SESSION_SECRET` - そうしないとマルチマシンデプロイ時にログイン状態が不一致になります +> - **共有Redisは必ず設定する必要があります** `CRYPTO_SECRET` - そうしないとデータを復号化できません + +### 🔄 チャネルリトライとキャッシュ + +**リトライ設定:** `設定 → 運営設定 → 一般設定 → 失敗リトライ回数` + +**キャッシュ設定:** +- `REDIS_CONN_STRING`：Redisキャッシュ（推奨） +- `MEMORY_CACHE_ENABLED`：メモリキャッシュ + +--- + +## 🔗 関連プロジェクト + +### 上流プロジェクト + +| プロジェクト | 説明 | +|------|------| +| [One API](https://github.com/songquanpeng/one-api) | オリジナルプロジェクトベース | +| [Midjourney-Proxy](https://github.com/novicezk/midjourney-proxy) | Midjourneyインターフェースサポート | + +### 補助ツール + +| プロジェクト | 説明 | +|------|------| +| [neko-api-key-tool](https://github.com/Calcium-Ion/neko-api-key-tool) | キー使用量クォータ照会ツール | +| [new-api-horizon](https://github.com/Calcium-Ion/new-api-horizon) | New API高性能最適化版 | + +--- + +## 💬 ヘルプサポート + +### 📖 ドキュメントリソース + +| リソース | リンク | +|------|------| +| 📘 よくある質問 | [FAQ](https://docs.newapi.pro/support/faq) | +| 💬 コミュニティ交流 | [交流チャネル](https://docs.newapi.pro/support/community-interaction) | +| 🐛 問題のフィードバック | [問題フィードバック](https://docs.newapi.pro/support/feedback-issues) | +| 📚 完全なドキュメント | [公式ドキュメント](https://docs.newapi.pro/support) | + +### 🤝 貢献ガイド + +あらゆる形の貢献を歓迎します！ + +- 🐛 バグを報告する +- 💡 新しい機能を提案する +- 📝 ドキュメントを改善する +- 🔧 コードを提出する + +--- + +## 🌟 スター履歴 + +
+ +[![スター履歴チャート](https://api.star-history.com/svg?repos=Calcium-Ion/new-api&type=Date)](https://star-history.com/#Calcium-Ion/new-api&Date) + +
+ +--- + +
+ +### 💖 New APIをご利用いただきありがとうございます + +このプロジェクトがあなたのお役に立てたなら、ぜひ ⭐️ スターをください！ + +**[公式ドキュメント](https://docs.newapi.pro/)** • **[問題フィードバック](https://github.com/Calcium-Ion/new-api/issues)** • **[最新リリース](https://github.com/Calcium-Ion/new-api/releases)** + +❤️ で構築された QuantumNous + +