QuantumNous/new-api

Maintainer? Show your league in your README

Card: your league's emblem, from Copper to Legendary

[![bestofgithub](https://bestofgithub.dev/badge/QuantumNous/new-api.svg?style=card)](https://bestofgithub.dev/repo/QuantumNous/new-api)

Flat: fits beside your other badges

[![bestofgithub](https://bestofgithub.dev/badge/QuantumNous/new-api.svg)](https://bestofgithub.dev/repo/QuantumNous/new-api)

Loading README…

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

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

Component	Options
Main database	SQLite, MySQL ≥ 5.7.8, or PostgreSQL ≥ 9.6
Separate log database	Configure with `LOG_SQL_DSN`; also supports ClickHouse
Cache	Optional Redis plus in-memory caching; use shared Redis when application nodes need shared rate limits
Container platforms	Linux amd64 / arm64

Variable	Purpose
`SQL_DSN`	Main database connection; unset uses SQLite
`LOG_SQL_DSN`	Optional separate log database connection
`REDIS_CONN_STRING`	Redis connection string
`SESSION_SECRET`	Persistent authentication secret; all nodes must use the same value
`CRYPTO_SECRET`	Defaults to `SESSION_SECRET`; nodes sharing Redis must use the same effective value
`SESSION_COOKIE_SECURE`	Set to `true` for an HTTPS console; enables Secure refresh cookies and strict refresh/logout origin checks
`SESSION_COOKIE_TRUSTED_URL`	Required in Secure mode: comma-separated exact HTTPS origins, without paths or wildcards; leave unset for local HTTP
`TRUSTED_PROXIES`	Trusted reverse-proxy IPs/CIDRs, or `none`; explicitly configure for your network

New API

Location	Responsibility
`router/`, `middleware/`, `controller/`	HTTP routes, access checks, and API handlers
`relay/`	Upstream adapters and request routing
`service/`, `model/`	Business logic and persistence
relaykit/	Independently buildable Go module for protocol DTOs and conversions
plugins/tasks/	JavaScript task plugins; see Task Plugin API v1 for authoring and host boundaries
`web/`	Web console; see frontend conventions
electron/	Desktop wrapper and packaging

Resource	Link
Official documentation	Guides · Installation · API reference
Project exploration	DeepWiki
Questions and discussion	FAQ · Community
Bugs and feature requests	GitHub Issues
Security reports	Follow the security policy for private reporting

Project	Description
One API	Original project base
Midjourney-Proxy	Midjourney interface support

Project	Description
new-api-key-tool	Key quota query tool
new-api-horizon	New API high-performance optimized version