One API is a self-hosted LLM API management and key redistribution system that exposes many model providers through the standard OpenAI API format, aimed at developers, teams and operators who want a single endpoint, a single key model and a single quota surface across providers.

What it is

One API is an open-source API gateway for large language models, written in JavaScript and released under the MIT licence. It ships as a single executable binary and as Docker images, with an English UI, and it sits in the Developer Tools / API Development & Testing category. Its project homepage is at https://oneapi.justsong.cn/, and its topics list it as an api, api-gateway, openai-api and proxy project that also covers azure-openai-api, chatgpt, claude, ernie-bot, gemini and gpt.

The concrete problem it solves is provider fragmentation. Without it, a client must speak the native protocol and carry the native credentials of every provider it uses: OpenAI ChatGPT and Azure OpenAI API, Anthropic Claude (including AWS Claude), Google PaLM2/Gemini, Mistral, ByteDance Doubao on Volcano Engine, Baidu ERNIE, Alibaba Qwen, iFlytek Spark, Zhipu ChatGLM, 360 Zhinao, Tencent Hunyuan, Moonshot AI, Baichuan, MINIMAX, Groq, Ollama, 01.AI, StepFun, Coze, Cohere, DeepSeek, Cloudflare Workers AI, DeepL, together.ai, novita.ai, SiliconFlow and xAI. One API replaces that per-provider client integration with one OpenAI-compatible surface: requests arrive in the standard OpenAI API format, and the gateway adapts, routes and accounts for them.

Key capabilities

• Unified OpenAI API format access to the provider list above, plus Azure OpenAI API and AWS Claude endpoints.
• Channel management with load balancing across multiple channels, batch channel creation, per-channel model lists, and automatic retry on failure.
• Token management that sets token expiry, quota, allowed IP range and allowed model access.
• Redemption code management with batch generation and export, letting codes recharge user accounts.
• User groups and channel groups, each configurable with its own multiplier rate, plus quota detail views, USD-denominated quota display and user invite rewards.
• Stream mode for typewriter-style streaming output, and an image generation interface.
• Management API driven by a system access token, documented in docs/API.md, so functionality can be extended and customised without forking the project.
• Multiple login paths: email registration with an optional whitelist and email-based password reset, Feishu authorisation, GitHub authorisation and WeChat official account authorisation, with Cloudflare Turnstile available for user verification.
• Customisation hooks: system name, logo and footer, homepage and About pages via HTML, Markdown or an iframe, and theme selection through the THEME environment variable.

Who uses it and how

• Small installs run the single container with the default SQLite storage, while larger deployments point at MySQL through the SQL_DSN environment variable and run multi-machine setups behind one endpoint.
• API resellers and internal platform teams use redemption codes, group multipliers, quota detail, invite rewards, announcements and charge links to operate a metered distribution service on top of upstream provider keys.
• Organisations that need managed identity use the email whitelist, Feishu, GitHub and WeChat official account login routes, with the WeChat path requiring an additional deployment of WeChat Server.
• Operators route alerts to messaging apps by pairing the gateway with Message Pusher, and deploy the Cloudflare AI Gateway as a channel proxy by filling https://gateway.ai.cloudflare.com/v1/ACCOUNT_TAG/GATEWAY/openai in the channel proxy field.
• Front-end teams customise branding, terms pages and about pages without touching application code.

Getting started

Deploy with Docker using the stable image justsong/one-api (or ghcr.io/songquanpeng/one-api), for example docker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api; add -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" to use MySQL instead of SQLite. Alpha images are published as justsong/one-api-alpha and ghcr.io/songquanpeng/one-api-alpha.

How it compares

This registry entry lists no paid products that One API is documented as replacing, and it names no directly comparable gateway project in the supplied facts, so on the evidence available it stands alone here. Its position is defined by its own terms: MIT licensed, self-hosted, single binary or Docker image, with the key management and redistribution layer included rather than sold as a hosted service.

When to use it — and when not to

A self-hoster must run and back up the data store, choosing between the default SQLite file and an external MySQL instance, and must change the default root password 123456 immediately after the first login. Compliance is on the operator: the project states that users must follow OpenAI's terms of use and applicable law, and that unregistered generative AI services must not be offered to the public in China under the Interim Measures for the Management of Generative AI Services. The project also carries a large open issue count (1036 at the time of writing), so anyone expecting a quiet, fully triaged tracker should look elsewhere.

# 使用 SQLite 的部署命令：
docker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api
# 使用 MySQL 的部署命令，在上面的基础上添加 `-e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi"`，请自行修改数据库连接参数，不清楚如何修改请参见下面环境变量一节。
# 例如：
docker run --name one-api -d --restart always -p 3000:3000 -e SQL_DSN="root:123456@tcp(localhost:3306)/oneapi" -e TZ=Asia/Shanghai -v /home/ubuntu/data/one-api:/data justsong/one-api

server{
   server_name openai.justsong.cn;  # 请根据实际情况修改你的域名

   location / {
          client_max_body_size  64m;
          proxy_http_version 1.1;
          proxy_pass http://localhost:3000;  # 请根据实际情况修改你的端口
          proxy_set_header Host $host;
          proxy_set_header X-Forwarded-For $remote_addr;
          proxy_cache_bypass $http_upgrade;
          proxy_set_header Accept-Encoding gzip;
          proxy_read_timeout 300s;  # GPT-4 需要较长的超时时间，请自行调整
   }
}

# Ubuntu 安装 certbot：
sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/bin/certbot
# 生成证书 & 修改 Nginx 配置
sudo certbot --nginx
# 根据指示进行操作
# 重启 Nginx
sudo service nginx restart

# 目前支持 MySQL 启动，数据存储在 ./data/mysql 文件夹内
docker-compose up -d

# 查看部署状态
docker-compose ps