QuantumNous/new-api

Capabilities

• 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, a

Storage and configuration

See the environment example, environment reference, and authentication and session guide for full configuration. Configure container variables in Compose's environment or envfile; copying .env.example alone does not inject variables into the container.

For production, put the console behind HTTPS and configure your reverse proxy for streaming and WebSocket upgrades. Persist and back up the database and mounted data. Multi-node deployments must share the main database and authentication secrets; separate Redis instances or in-memory rate limiters count limits independently per node. The session guide describes propagation behavior for each topology.

Pin an image version from Releases, review its upgrade notes, and back up before upgrading. The latest tag follows published builds and can change; migrations and compatibility must be assessed for your existing installation.

• Main database — SQLite, MySQL ≥ 5.7.8, or PostgreSQL ≥ 9.6
• Separate log database — Configure with LOGSQLDSN; 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
• SQLDSN — Main database connection; unset uses SQLite
• LOGSQLDSN — Optional separate log database connection
• REDISCONNSTRING — Redis connection string
• SESSIONSECRET — Persistent authentication secret; all nodes must use the same value
• CRYPTOSECRET — Defaults to SESSIONSECRET; nodes sharing Redis must use the same effective value
• SESSIONCOOKIESECURE — Set to true for an HTTPS console; enables Secure refresh cookies and strict refresh/logout origin checks
• SESSIONCOOKIETRUSTEDURL — Required in Secure mode: comma-separated exact HTTPS origins, without paths or wildcards; leave unset for local HTTP
• TRUSTEDPROXIES — Trusted reverse-proxy IPs/CIDRs, or none; explicitly configure for your network

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.

• Model square — Usage logs

Protocols and endpoints

RelayKit 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.

• 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

Make your first request

Set NEWAPIKEY in your shell to that key. List the models accessible to it:

Then call Responses, replacing your-enabled-model with an enabled model that supports this interface:

• Add a channel with your upstream API key, available models, and group assignment; run a channel test.
• Configure model pricing and ensure the user has quota or a valid subscription.
• Create an API key in the console with access to the same group and models.
• Set your client's base URL to http://localhost:3000/v1 for OpenAI-compatible clients and use the New API-issued key.