- 中文 | - English | - Français | + 简体中文 | + 繁體中文 | + English | + Français | 日本語
@@ -45,26 +46,54 @@- Quick Start • - Key Features • - Deployment • - Documentation • - Help + Screenshots • + Capabilities • + Quick start • + Deployment • + Development • + Documentation
+--- + ## 📝 Project Description -> [!NOTE] +New API is a self-hosted AI gateway for applications, agents, and teams. Connect upstream model services, expose a consistent API to your clients, and manage routing, access, usage, and costs in one place. + +Use it to share authorized model access across a team, switch providers without configuring every client again, or operate a private multi-model service with a web console. Upstreams include OpenAI, Anthropic, Google Gemini, Azure OpenAI, AWS Bedrock, Vertex AI, DeepSeek, Qwen, and other compatible services. + +> [!NOTE] > This is an open-source project developed based on [One API](https://github.com/songquanpeng/one-api) -> [!IMPORTANT] + + +> [!IMPORTANT] > - This project is intended solely for lawful and authorized AI API gateway, organization-level authentication, multi-model management, usage analytics, cost accounting, and private deployment scenarios. > - Users must lawfully obtain upstream API keys, accounts, model services, and interface permissions, and must comply with upstream terms of service and applicable laws and regulations. > - Users should ensure their use complies with upstream terms of service and applicable laws and regulations. > - When providing generative AI services to the public, users should comply with applicable regulatory requirements and fulfill all filing, licensing, content safety, real-name verification, log retention, tax, and upstream authorization obligations required by their jurisdiction. + + +> [!WARNING] +> When operating this project as a public generative AI service or API resale service, users should first complete all required filing, licensing, content safety, real-name verification, log retention, tax, payment, and upstream authorization obligations. + +--- + + + +## Screenshots + +Accounts, channels, plugin installation states, usage, prices, and costs shown below are simulated data. The marketplace displays the official plugin catalog. Click an image to view it at full size. + +| Usage dashboard | Plugin marketplace | +| --- | --- | +| [](assets/screenshots/dashboard.en.jpg) | [](assets/screenshots/plugin-marketplace.en.jpg) | +| **Model square** | **Usage logs** | +| [](assets/screenshots/models.en.jpg) | [](assets/screenshots/usage-logs.en.jpg) | + --- ## 🤝 Trusted Partners @@ -80,9 +109,6 @@
-
- 
-
@@ -107,324 +133,174 @@
---
-## 🚀 Quick Start
+
-### Using Docker Compose (Recommended)
+## Capabilities
+
+| Area | What you can do |
+| --- | --- |
+| Model access | Use OpenAI Chat Completions, Responses, Anthropic Messages, and Gemini APIs; stream responses and use tools, reasoning, and multimodal inputs where supported |
+| Routing | Configure model mappings, channel priorities and weights, retries, channel affinity, and multiple upstream keys |
+| Usage and costs | Manage quotas, subscriptions, usage logs, cache accounting, and expression-based pricing for different usage tiers |
+| Access control | Manage users, groups, fine-grained permissions, and API key restrictions; use OAuth/OIDC, passkeys, two-factor authentication, and login session management |
+| Asynchronous tasks | Extend image, video, and other task APIs with JavaScript plugins, including task status and output retrieval |
+| Web console | Configure channels and models, inspect usage and audit logs, and try models in the playground; available in English, Simplified Chinese, Traditional Chinese, French, Japanese, Russian, and Vietnamese |
+
+### Protocols and endpoints
+
+| Interface | Common endpoints |
+| --- | --- |
+| OpenAI Chat / Responses | `POST /v1/chat/completions`, `POST /v1/responses` |
+| Anthropic Messages | `POST /v1/messages` |
+| Gemini | `POST /v1beta/models/{model}:generateContent`, `POST /v1beta/models/{model}:streamGenerateContent` |
+| Realtime / Responses WebSocket | `GET /v1/realtime`, `GET /v1/responses` (WebSocket upgrade) |
+| Images / audio | `/v1/images/generations`, `/v1/images/edits`, `/v1/audio/speech`, `/v1/audio/transcriptions`, `/v1/audio/translations` |
+| Embeddings / rerank | `POST /v1/embeddings`, `POST /v1/rerank` |
+| Task plugins | `POST /v1/tasks/{pluginKey}`, `GET /v1/tasks/{taskId}`, plus routes declared by each plugin |
+
+[RelayKit](./relaykit/README.md) provides request, response, and streaming conversion between the four text protocols. Available features depend on the channel, upstream model, and conversion path; protocol-specific tools and fields may not map exactly. WebSocket support also requires a compatible upstream and channel configuration.
+
+This README describes the current source tree. Check the release notes for the version you deploy.
+
+
+
+## Quick start
+
+### Try locally with Docker
+
+This starts a single instance with SQLite and binds it to localhost:
+
+```bash
+mkdir -p data
+docker run --name new-api -d --restart unless-stopped \
+ -p 127.0.0.1:3000:3000 \
+ -e TZ=Asia/Shanghai \
+ -v "$(pwd)/data:/data" \
+ calciumion/new-api:latest
+```
+
+Open [http://localhost:3000](http://localhost:3000) and complete the setup wizard to create the administrator account. The `data` directory persists the SQLite database across container replacements.
+
+### Make your first request
+
+1. Add a channel with your upstream API key, available models, and group assignment; run a channel test.
+2. Configure model pricing and ensure the user has quota or a valid subscription.
+3. Create an API key in the console with access to the same group and models.
+4. Set your client's base URL to `http://localhost:3000/v1` for OpenAI-compatible clients and use the **New API-issued key**.
+
+Set `NEW_API_KEY` in your shell to that key. List the models accessible to it:
+
+```bash
+curl --fail-with-body http://localhost:3000/v1/models \
+ -H "Authorization: Bearer ${NEW_API_KEY}"
+```
+
+Then call Responses, replacing `your-enabled-model` with an enabled model that supports this interface:
+
+```bash
+curl --fail-with-body http://localhost:3000/v1/responses \
+ -H "Authorization: Bearer ${NEW_API_KEY}" \
+ -H "Content-Type: application/json" \
+ -d '{"model":"your-enabled-model","input":"Hello!"}'
+```
+
+
+
+## Deployment
+
+### Docker Compose
+
+The repository's [Compose configuration](./docker-compose.yml) starts **New API + PostgreSQL + Redis** by default. It also contains examples for MySQL and a separate ClickHouse log database.
```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
```
-简体中文 | @@ -44,23 +44,34 @@
- Démarrage rapide • - Fonctionnalités clés • - Déploiement • - Documentation • - Aide + Fonctionnalités • + Démarrage rapide • + Déploiement • + Développement • + Documentation
+--- + ## 📝 Description du projet +New API est une passerelle IA auto-hébergée pour les applications, les agents et les équipes. Connectez vos fournisseurs de modèles, exposez une API commune à vos clients et gérez le routage, les accès, les usages et les coûts depuis une même console. + +Utilisez-la pour partager des accès autorisés au sein d'une équipe, changer de fournisseur sans reconfigurer chaque client ou exploiter un service privé multi-modèles. Les fournisseurs incluent OpenAI, Anthropic, Google Gemini, Azure OpenAI, AWS Bedrock, Vertex AI, DeepSeek, Qwen et d'autres services compatibles. + > [!IMPORTANT] > - Ce projet est exclusivement destiné aux scénarios de passerelle API d'IA légalement autorisés, d'authentification organisationnelle, de gestion multi-modèles, d'analyse d'utilisation, de comptabilisation des coûts et de déploiement privé. > - Les utilisateurs doivent obtenir légalement les clés API, comptes, services de modèles et autorisations d'interface en amont, et doivent respecter les conditions d'utilisation en amont et les lois et réglementations applicables. > - Les utilisateurs doivent s'assurer que leur utilisation est conforme aux conditions d'utilisation en amont et aux lois et réglementations applicables. > - Lors de la fourniture de services d'IA générative au public, les utilisateurs doivent se conformer aux exigences réglementaires applicables et remplir toutes les obligations d'enregistrement, de licence, de sécurité du contenu, de vérification d'identité, de conservation des journaux, de fiscalité et d'autorisation en amont requises par leur juridiction. + + +> [!WARNING] +> Lorsque vous exploitez ce projet en tant que service public d'IA générative ou service de revente d'API, les utilisateurs doivent d'abord remplir toutes les obligations requises en matière d'enregistrement, de licence, de sécurité du contenu, de vérification d'identité, de conservation des journaux, de fiscalité, de paiement et d'autorisation en amont. + --- ## 🤝 Partenaires de confiance @@ -79,9 +90,6 @@ -->
-
-
+
+> [!WARNING]
+> 本プロジェクトを公衆向け生成 AI サービスまたは API 再販サービスとして運営する場合、ユーザーは届出、コンテンツセキュリティ、本人確認、ログ保持、税務、決済、上流認可などの必要なコンプライアンス義務を先に完了してください。
+
---
## 🤝 信頼できるパートナー
@@ -79,9 +90,6 @@
-->
-
-
+
+> [!WARNING]
+> When operating this project as a public generative AI service or API resale service, users should first complete all required filing, licensing, content safety, real-name verification, log retention, tax, payment, and upstream authorization obligations.
+
+---
+
+
+
+## Screenshots
+
+Accounts, channels, plugin installation states, usage, prices, and costs shown below are simulated data. The marketplace displays the official plugin catalog. Click an image to view it at full size.
+
+| Usage dashboard | Plugin marketplace |
+| --- | --- |
+| [](assets/screenshots/dashboard.en.jpg) | [](assets/screenshots/plugin-marketplace.en.jpg) |
+| **Model square** | **Usage logs** |
+| [](assets/screenshots/models.en.jpg) | [](assets/screenshots/usage-logs.en.jpg) |
+
---
## 🤝 Trusted Partners
@@ -79,9 +105,6 @@
-->
-
-
+
+> [!WARNING]
+> 将本项目作为面向公众的生成式 AI 服务或 API 转售服务运营时，使用者应先完成备案、内容安全、实名、日志留存、税务、支付和上游授权等合规义务。
+
+---
+
+
+
+## 项目截图
+
+以下账号、渠道、插件安装状态、用量、价格和费用均为模拟数据，插件市场展示官方目录。点击图片可查看原图。
+
+| 数据看板 | 插件市场 |
+| --- | --- |
+| [](assets/screenshots/dashboard.zh-CN.jpg) | [](assets/screenshots/plugin-marketplace.zh-CN.jpg) |
+| **模型广场** | **使用日志** |
+| [](assets/screenshots/models.zh-CN.jpg) | [](assets/screenshots/usage-logs.zh-CN.jpg) |
+
---
## 🤝 我们信任的合作伙伴
@@ -79,9 +105,6 @@
-->
-
-
+
+> [!WARNING]
+> 將本專案作為面向公眾的生成式 AI 服務或 API 轉售服務運營時，使用者應先完成備案、內容安全、實名、日誌留存、稅務、支付和上游授權等合規義務。
+
---
## 🤝 我們信任的合作伙伴
@@ -78,9 +89,6 @@
-->
-
-
+
diff --git a/web/package.json b/web/package.json
index 3f098d2..8b5376d 100644
--- a/web/package.json
+++ b/web/package.json
@@ -36,25 +36,25 @@
"@hugeicons/core-free-icons": "^4.2.2",
"@hugeicons/react": "^1.1.9",
"@lezer/highlight": "^1.2.3",
- "@lobehub/icons": "^5.10.1",
+ "@lobehub/icons": "~5.22.0",
"@tanstack/react-query": "^5.101.2",
"@tanstack/react-router": "^1.170.17",
"@tanstack/react-table": "^8.21.3",
"@tanstack/react-virtual": "^3.14.5",
"@visactor/react-vchart": "^2.1.2",
"@visactor/vchart": "^2.1.2",
- "ai": "^7.0.14",
+ "ai": "^7.0.136",
"auto-skeleton-react": "^1.0.5",
"axios": "^1.18.1",
"class-variance-authority": "^0.7.1",
"clsx": "^2.1.1",
"cmdk": "^1.1.1",
"dayjs": "^1.11.21",
- "dompurify": "3.4.13",
+ "dompurify": "3.4.16",
"i18next": "^26.3.4",
"i18next-browser-languagedetector": "^8.2.1",
"input-otp": "^1.4.2",
- "katex": "^0.17.0",
+ "katex": "^0.18.2",
"lucide-react": "^1.23.0",
"marked": "^18.0.5",
"motion": "^12.42.2",
@@ -74,14 +74,14 @@
"shiki": "^4.3.0",
"sonner": "^2.0.7",
"sse.js": "^2.8.0",
- "stream-markdown-parser": "^1.0.9",
+ "stream-markdown-parser": "^1.2.18",
"tailwind-merge": "^3.6.0",
"tailwindcss": "^4.3.2",
"tokenlens": "^1.3.1",
"tw-animate-css": "^1.4.0",
"use-stick-to-bottom": "^1.1.6",
"vaul": "^1.1.2",
- "yace": "^1.1.0",
+ "yace": "^1.1.1",
"yaml": "^2.9.0",
"zod": "^4.4.3",
"zustand": "^5.0.14"
@@ -92,7 +92,7 @@
"@rsbuild/plugin-tailwindcss": "^2.0.3",
"@tanstack/react-query-devtools": "^5.101.2",
"@tanstack/react-router-devtools": "^1.167.0",
- "@tanstack/router-plugin": "^1.168.19",
+ "@tanstack/router-plugin": "^1.168.42",
"@testing-library/jest-dom": "^7.0.0",
"@testing-library/react": "^16.3.2",
"@testing-library/user-event": "^14.6.1",
@@ -105,18 +105,19 @@
"embla-carousel-react": "^8.6.0",
"jsdom": "^29.1.1",
"knip": "^6.24.0",
- "oxfmt": "^0.57.0",
+ "oxfmt": "^0.72.0",
"oxlint": "^1.72.0",
"shadcn": "^4.12.0",
"vitest": "^4.1.10"
},
"overrides": {
"brace-expansion": "2.1.1",
- "dompurify": "3.4.13",
+ "dompurify": "3.4.16",
"fast-uri": "3.1.2",
"hono": "4.12.22",
"ip-address": "10.2.0",
"js-cookie": "3.0.7",
+ "katex": "0.18.2",
"mermaid": "11.15.0",
"minimist": "1.2.8",
"postcss": "8.5.15",
diff --git a/web/public/custom-site-icon.png b/web/public/custom-site-icon.png
new file mode 100644
index 0000000..bc17c58
Binary files /dev/null and b/web/public/custom-site-icon.png differ
diff --git a/web/public/favicon.ico b/web/public/favicon.ico
index ab5f17b..7a480b2 100644
Binary files a/web/public/favicon.ico and b/web/public/favicon.ico differ
diff --git a/web/public/logo.png b/web/public/logo.png
index 851556f..918700c 100644
Binary files a/web/public/logo.png and b/web/public/logo.png differ
diff --git a/web/rsbuild.config.ts b/web/rsbuild.config.ts
index e0d9c25..2c2fd3f 100644
--- a/web/rsbuild.config.ts
+++ b/web/rsbuild.config.ts
@@ -14,6 +14,9 @@ export default defineConfig(({ envMode }) => {
process.env.VITE_REACT_APP_SERVER_URL ||
env.rawPublicVars.VITE_REACT_APP_SERVER_URL ||
'http://localhost:3000'
+ const siteFavicon =
+ process.env.VITE_REACT_APP_FAVICON ||
+ env.rawPublicVars.VITE_REACT_APP_FAVICON
const isProd = envMode === 'production'
const devProxy = Object.fromEntries(
@@ -53,6 +56,11 @@ export default defineConfig(({ envMode }) => {
},
},
source: {
+ define: {
+ 'import.meta.env.VITE_REACT_APP_FAVICON': JSON.stringify(
+ siteFavicon || ''
+ ),
+ },
entry: {
index: './src/main.tsx',
},
@@ -64,6 +72,7 @@ export default defineConfig(({ envMode }) => {
},
html: {
template: './index.html',
+ favicon: siteFavicon ? `./public${siteFavicon}` : './public/favicon.ico',
},
server: {
host: '0.0.0.0',
diff --git a/web/src/assets/brand-icons/icon-alipay.tsx b/web/src/assets/brand-icons/icon-alipay.tsx
new file mode 100644
index 0000000..07666a0
--- /dev/null
+++ b/web/src/assets/brand-icons/icon-alipay.tsx
@@ -0,0 +1,38 @@
+/*
+Copyright (C) 2023-2026 QuantumNous
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see Long content
+