[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-1907":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":20,"compositeScore":21,"rankGlobal":10,"rankLanguage":10,"license":22,"archived":23,"fork":23,"defaultBranch":24,"hasWiki":25,"hasPages":23,"topics":26,"createdAt":10,"pushedAt":10,"updatedAt":38,"readmeContent":39,"aiSummary":40,"trendingCount":16,"starSnapshotCount":16,"syncStatus":41,"lastSyncTime":42,"discoverSource":43},1907,"one-api","songquanpeng\u002Fone-api","songquanpeng","LLM API 管理 & 分发系统，支持 OpenAI、Azure、Anthropic Claude、Google Gemini、DeepSeek、字节豆包、ChatGLM、文心一言、讯飞星火、通义千问、360 智脑、腾讯混元等主流模型，统一 API 适配，可用于 key 管理与二次分发。单可执行文件，提供 Docker 镜像，一键部署，开箱即用。LLM API management & key redistribution system, unifying multiple providers under a single API. Single binary, Docker-ready, with an English UI.","https:\u002F\u002Foneapi.justsong.cn\u002F",null,"JavaScript",34851,6616,168,913,0,38,246,1372,182,45,"MIT License",false,"main",true,[27,28,29,30,31,32,33,34,35,36,37],"api","api-gateway","azure-openai-api","chatgpt","claude","ernie-bot","gemini","gpt","openai","openai-api","proxy","2026-06-12 02:00:34","\u003Cp align=\"right\">\n   \u003Cstrong>中文\u003C\u002Fstrong> | \u003Ca href=\".\u002FREADME.en.md\">English\u003C\u002Fa> | \u003Ca href=\".\u002FREADME.ja.md\">日本語\u003C\u002Fa>\n\u003C\u002Fp>\n\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\">\u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002Fsongquanpeng\u002Fone-api\u002Fmain\u002Fweb\u002Fdefault\u002Fpublic\u002Flogo.png\" width=\"150\" height=\"150\" alt=\"one-api logo\">\u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003Cdiv align=\"center\">\n\n# One API\n\n_✨ 通过标准的 OpenAI API 格式访问所有的大模型，开箱即用 ✨_\n\n\u003C\u002Fdiv>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fraw.githubusercontent.com\u002Fsongquanpeng\u002Fone-api\u002Fmain\u002FLICENSE\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002Fsongquanpeng\u002Fone-api?color=brightgreen\" alt=\"license\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Freleases\u002Flatest\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fv\u002Frelease\u002Fsongquanpeng\u002Fone-api?color=brightgreen&include_prereleases\" alt=\"release\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fhub.docker.com\u002Frepository\u002Fdocker\u002Fjustsong\u002Fone-api\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fdocker\u002Fpulls\u002Fjustsong\u002Fone-api?color=brightgreen\" alt=\"docker pull\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Freleases\u002Flatest\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fdownloads\u002Fsongquanpeng\u002Fone-api\u002Ftotal?color=brightgreen&include_prereleases\" alt=\"release\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgoreportcard.com\u002Freport\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\">\n    \u003Cimg src=\"https:\u002F\u002Fgoreportcard.com\u002Fbadge\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\" alt=\"GoReportCard\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api#部署\">部署教程\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api#使用方法\">使用方法\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fissues\">意见反馈\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api#截图展示\">截图展示\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fopenai.justsong.cn\u002F\">在线演示\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api#常见问题\">常见问题\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api#相关项目\">相关项目\u003C\u002Fa>\n  ·\n  \u003Ca href=\"https:\u002F\u002Fiamazing.cn\u002Fpage\u002Freward\">赞赏支持\u003C\u002Fa>\n\u003C\u002Fp>\n\n> [!NOTE]\n> 本项目为开源项目，使用者必须在遵循 OpenAI 的[使用条款](https:\u002F\u002Fopenai.com\u002Fpolicies\u002Fterms-of-use)以及**法律法规**的情况下使用，不得用于非法用途。\n>\n> 根据[《生成式人工智能服务管理暂行办法》](http:\u002F\u002Fwww.cac.gov.cn\u002F2023-07\u002F13\u002Fc_1690898327029107.htm)的要求，请勿对中国地区公众提供一切未经备案的生成式人工智能服务。\n\n> [!NOTE]\n> 稳定版 \u002F 预览版镜像地址：[justsong\u002Fone-api](https:\u002F\u002Fhub.docker.com\u002Frepository\u002Fdocker\u002Fjustsong\u002Fone-api)\n> 或者 [ghcr.io\u002Fsongquanpeng\u002Fone-api](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fpkgs\u002Fcontainer\u002Fone-api)\n>\n> alpha 版镜像地址：[justsong\u002Fone-api-alpha](https:\u002F\u002Fhub.docker.com\u002Frepository\u002Fdocker\u002Fjustsong\u002Fone-api-alpha)\n> 或者 [ghcr.io\u002Fsongquanpeng\u002Fone-api-alpha](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fpkgs\u002Fcontainer\u002Fone-api-alpha)\n\n> [!WARNING]\n> 使用 root 用户初次登录系统后，务必修改默认密码 `123456`！\n\n## 功能\n1. 支持多种大模型：\n   + [x] [OpenAI ChatGPT 系列模型](https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fguides\u002Fgpt\u002Fchat-completions-api)（支持 [Azure OpenAI API](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fazure\u002Fai-services\u002Fopenai\u002Freference)）\n   + [x] [Anthropic Claude 系列模型](https:\u002F\u002Fanthropic.com) (支持 AWS Claude)\n   + [x] [Google PaLM2\u002FGemini 系列模型](https:\u002F\u002Fdevelopers.generativeai.google)\n   + [x] [Mistral 系列模型](https:\u002F\u002Fmistral.ai\u002F)\n   + [x] [字节跳动豆包大模型（火山引擎）](https:\u002F\u002Fwww.volcengine.com\u002Fexperience\u002Fark?utm_term=202502dsinvite&ac=DSASUQY5&rc=2QXCA1VI)\n   + [x] [百度文心一言系列模型](https:\u002F\u002Fcloud.baidu.com\u002Fdoc\u002FWENXINWORKSHOP\u002Findex.html)\n   + [x] [阿里通义千问系列模型](https:\u002F\u002Fhelp.aliyun.com\u002Fdocument_detail\u002F2400395.html)\n   + [x] [讯飞星火认知大模型](https:\u002F\u002Fwww.xfyun.cn\u002Fdoc\u002Fspark\u002FWeb.html)\n   + [x] [智谱 ChatGLM 系列模型](https:\u002F\u002Fbigmodel.cn)\n   + [x] [360 智脑](https:\u002F\u002Fai.360.cn)\n   + [x] [腾讯混元大模型](https:\u002F\u002Fcloud.tencent.com\u002Fdocument\u002Fproduct\u002F1729)\n   + [x] [Moonshot AI](https:\u002F\u002Fplatform.moonshot.cn\u002F)\n   + [x] [百川大模型](https:\u002F\u002Fplatform.baichuan-ai.com)\n   + [x] [MINIMAX](https:\u002F\u002Fapi.minimax.chat\u002F)\n   + [x] [Groq](https:\u002F\u002Fwow.groq.com\u002F)\n   + [x] [Ollama](https:\u002F\u002Fgithub.com\u002Follama\u002Follama)\n   + [x] [零一万物](https:\u002F\u002Fplatform.lingyiwanwu.com\u002F)\n   + [x] [阶跃星辰](https:\u002F\u002Fplatform.stepfun.com\u002F)\n   + [x] [Coze](https:\u002F\u002Fwww.coze.com\u002F)\n   + [x] [Cohere](https:\u002F\u002Fcohere.com\u002F)\n   + [x] [DeepSeek](https:\u002F\u002Fwww.deepseek.com\u002F)\n   + [x] [Cloudflare Workers AI](https:\u002F\u002Fdevelopers.cloudflare.com\u002Fworkers-ai\u002F)\n   + [x] [DeepL](https:\u002F\u002Fwww.deepl.com\u002F)\n   + [x] [together.ai](https:\u002F\u002Fwww.together.ai\u002F)\n   + [x] [novita.ai](https:\u002F\u002Fwww.novita.ai\u002F)\n   + [x] [硅基流动 SiliconCloud](https:\u002F\u002Fcloud.siliconflow.cn\u002Fi\u002FrKXmRobW)\n   + [x] [xAI](https:\u002F\u002Fx.ai\u002F)\n2. 支持配置镜像以及众多[第三方代理服务](https:\u002F\u002Fiamazing.cn\u002Fpage\u002Fopenai-api-third-party-services)。\n3. 支持通过**负载均衡**的方式访问多个渠道。\n4. 支持 **stream 模式**，可以通过流式传输实现打字机效果。\n5. 支持**多机部署**，[详见此处](#多机部署)。\n6. 支持**令牌管理**，设置令牌的过期时间、额度、允许的 IP 范围以及允许的模型访问。\n7. 支持**兑换码管理**，支持批量生成和导出兑换码，可使用兑换码为账户进行充值。\n8. 支持**渠道管理**，批量创建渠道。\n9. 支持**用户分组**以及**渠道分组**，支持为不同分组设置不同的倍率。\n10. 支持渠道**设置模型列表**。\n11. 支持**查看额度明细**。\n12. 支持**用户邀请奖励**。\n13. 支持以美元为单位显示额度。\n14. 支持发布公告，设置充值链接，设置新用户初始额度。\n15. 支持模型映射，重定向用户的请求模型，如无必要请不要设置，设置之后会导致请求体被重新构造而非直接透传，会导致部分还未正式支持的字段无法传递成功。\n16. 支持失败自动重试。\n17. 支持绘图接口。\n18. 支持 [Cloudflare AI Gateway](https:\u002F\u002Fdevelopers.cloudflare.com\u002Fai-gateway\u002Fproviders\u002Fopenai\u002F)，渠道设置的代理部分填写 `https:\u002F\u002Fgateway.ai.cloudflare.com\u002Fv1\u002FACCOUNT_TAG\u002FGATEWAY\u002Fopenai` 即可。\n19. 支持丰富的**自定义**设置，\n    1. 支持自定义系统名称，logo 以及页脚。\n    2. 支持自定义首页和关于页面，可以选择使用 HTML & Markdown 代码进行自定义，或者使用一个单独的网页通过 iframe 嵌入。\n20. 支持通过系统访问令牌调用管理 API，进而**在无需二开的情况下扩展和自定义** One API 的功能，详情请参考此处 [API 文档](.\u002Fdocs\u002FAPI.md)。\n21. 支持 Cloudflare Turnstile 用户校验。\n22. 支持用户管理，支持**多种用户登录注册方式**：\n    + 邮箱登录注册（支持注册邮箱白名单）以及通过邮箱进行密码重置。\n    + 支持[飞书授权登录](https:\u002F\u002Fopen.feishu.cn\u002Fdocument\u002FuAjLw4CM\u002FukTMukTMukTM\u002Freference\u002Fauthen-v1\u002Fauthorize\u002Fget)（[这里有 One API 的实现细节阐述供参考](https:\u002F\u002Fiamazing.cn\u002Fpage\u002Ffeishu-oauth-login)）。\n    + 支持 [GitHub 授权登录](https:\u002F\u002Fgithub.com\u002Fsettings\u002Fapplications\u002Fnew)。\n    + 微信公众号授权（需要额外部署 [WeChat Server](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fwechat-server)）。\n23. 支持主题切换，设置环境变量 `THEME` 即可，默认为 `default`，欢迎 PR 更多主题，具体参考[此处](.\u002Fweb\u002FREADME.md)。\n24. 配合 [Message Pusher](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fmessage-pusher) 可将报警信息推送到多种 App 上。\n\n## 部署\n### 基于 Docker 进行部署\n```shell\n# 使用 SQLite 的部署命令：\ndocker run --name one-api -d --restart always -p 3000:3000 -e TZ=Asia\u002FShanghai -v \u002Fhome\u002Fubuntu\u002Fdata\u002Fone-api:\u002Fdata justsong\u002Fone-api\n# 使用 MySQL 的部署命令，在上面的基础上添加 `-e SQL_DSN=\"root:123456@tcp(localhost:3306)\u002Foneapi\"`，请自行修改数据库连接参数，不清楚如何修改请参见下面环境变量一节。\n# 例如：\ndocker run --name one-api -d --restart always -p 3000:3000 -e SQL_DSN=\"root:123456@tcp(localhost:3306)\u002Foneapi\" -e TZ=Asia\u002FShanghai -v \u002Fhome\u002Fubuntu\u002Fdata\u002Fone-api:\u002Fdata justsong\u002Fone-api\n```\n\n其中，`-p 3000:3000` 中的第一个 `3000` 是宿主机的端口，可以根据需要进行修改。\n\n数据和日志将会保存在宿主机的 `\u002Fhome\u002Fubuntu\u002Fdata\u002Fone-api` 目录，请确保该目录存在且具有写入权限，或者更改为合适的目录。\n\n如果启动失败，请添加 `--privileged=true`，具体参考 https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fissues\u002F482 。\n\n如果上面的镜像无法拉取，可以尝试使用 GitHub 的 Docker 镜像，将上面的 `justsong\u002Fone-api` 替换为 `ghcr.io\u002Fsongquanpeng\u002Fone-api` 即可。\n\n如果你的并发量较大，**务必**设置 `SQL_DSN`，详见下面[环境变量](#环境变量)一节。\n\n更新命令：`docker run --rm -v \u002Fvar\u002Frun\u002Fdocker.sock:\u002Fvar\u002Frun\u002Fdocker.sock containrrr\u002Fwatchtower -cR`\n\nNginx 的参考配置：\n```\nserver{\n   server_name openai.justsong.cn;  # 请根据实际情况修改你的域名\n\n   location \u002F {\n          client_max_body_size  64m;\n          proxy_http_version 1.1;\n          proxy_pass http:\u002F\u002Flocalhost:3000;  # 请根据实际情况修改你的端口\n          proxy_set_header Host $host;\n          proxy_set_header X-Forwarded-For $remote_addr;\n          proxy_cache_bypass $http_upgrade;\n          proxy_set_header Accept-Encoding gzip;\n          proxy_read_timeout 300s;  # GPT-4 需要较长的超时时间，请自行调整\n   }\n}\n```\n\n之后使用 Let's Encrypt 的 certbot 配置 HTTPS：\n```bash\n# Ubuntu 安装 certbot：\nsudo snap install --classic certbot\nsudo ln -s \u002Fsnap\u002Fbin\u002Fcertbot \u002Fusr\u002Fbin\u002Fcertbot\n# 生成证书 & 修改 Nginx 配置\nsudo certbot --nginx\n# 根据指示进行操作\n# 重启 Nginx\nsudo service nginx restart\n```\n\n初始账号用户名为 `root`，密码为 `123456`。\n\n### 通过宝塔面板进行一键部署\n1. 安装宝塔面板9.2.0及以上版本，前往 [宝塔面板](https:\u002F\u002Fwww.bt.cn\u002Fnew\u002Fdownload.html?r=dk_oneapi) 官网，选择正式版的脚本下载安装；\n2. 安装后登录宝塔面板，在左侧菜单栏中点击 `Docker`，首次进入会提示安装 `Docker` 服务，点击立即安装，按提示完成安装；\n3. 安装完成后在应用商店中搜索 `One-API`，点击安装，配置域名等基本信息即可完成安装；\n\n### 基于 Docker Compose 进行部署\n\n> 仅启动方式不同，参数设置不变，请参考基于 Docker 部署部分\n\n```shell\n# 目前支持 MySQL 启动，数据存储在 .\u002Fdata\u002Fmysql 文件夹内\ndocker-compose up -d\n\n# 查看部署状态\ndocker-compose ps\n```\n\n### 手动部署\n1. 从 [GitHub Releases](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Freleases\u002Flatest) 下载可执行文件或者从源码编译：\n   ```shell\n   git clone https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api.git\n\n   # 构建前端\n   cd one-api\u002Fweb\u002Fdefault\n   npm install\n   npm run build\n\n   # 构建后端\n   cd ..\u002F..\n   go mod download\n   go build -ldflags \"-s -w\" -o one-api\n   ````\n2. 运行：\n   ```shell\n   chmod u+x one-api\n   .\u002Fone-api --port 3000 --log-dir .\u002Flogs\n   ```\n3. 访问 [http:\u002F\u002Flocalhost:3000\u002F](http:\u002F\u002Flocalhost:3000\u002F) 并登录。初始账号用户名为 `root`，密码为 `123456`。\n\n更加详细的部署教程[参见此处](https:\u002F\u002Fiamazing.cn\u002Fpage\u002Fhow-to-deploy-a-website)。\n\n### 多机部署\n1. 所有服务器 `SESSION_SECRET` 设置一样的值。\n2. 必须设置 `SQL_DSN`，使用 MySQL 数据库而非 SQLite，所有服务器连接同一个数据库。\n3. 所有从服务器必须设置 `NODE_TYPE` 为 `slave`，不设置则默认为主服务器。\n4. 设置 `SYNC_FREQUENCY` 后服务器将定期从数据库同步配置，在使用远程数据库的情况下，推荐设置该项并启用 Redis，无论主从。\n5. 从服务器可以选择设置 `FRONTEND_BASE_URL`，以重定向页面请求到主服务器。\n6. 从服务器上**分别**装好 Redis，设置好 `REDIS_CONN_STRING`，这样可以做到在缓存未过期的情况下数据库零访问，可以减少延迟（Redis 集群或者哨兵模式的支持请参考环境变量说明）。\n7. 如果主服务器访问数据库延迟也比较高，则也需要启用 Redis，并设置 `SYNC_FREQUENCY`，以定期从数据库同步配置。\n\n环境变量的具体使用方法详见[此处](#环境变量)。\n\n### 宝塔部署教程\n\n详见 [#175](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fissues\u002F175)。\n\n如果部署后访问出现空白页面，详见 [#97](https:\u002F\u002Fgithub.com\u002Fsongquanpeng\u002Fone-api\u002Fissues\u002F97)。\n\n### 部署第三方服务配合 One API 使用\n> 欢迎 PR 添加更多示例。\n\n#### ChatGPT Next Web\n项目主页：https:\u002F\u002Fgithub.com\u002FYidadaa\u002FChatGPT-Next-Web\n\n```bash\ndocker run --name chat-next-web -d -p 3001:3000 yidadaa\u002Fchatgpt-next-web\n```\n\n注意修改端口号，之后在页面上设置接口地址（例如：https:\u002F\u002Fopenai.justsong.cn\u002F ）和 API Key 即可。\n\n#### ChatGPT Web\n项目主页：https:\u002F\u002Fgithub.com\u002FChanzhaoyu\u002Fchatgpt-web\n\n```bash\ndocker run --name chatgpt-web -d -p 3002:3002 -e OPENAI_API_BASE_URL=https:\u002F\u002Fopenai.justsong.cn -e OPENAI_API_KEY=sk-xxx chenzhaoyu94\u002Fchatgpt-web\n```\n\n注意修改端口号、`OPENAI_API_BASE_URL` 和 `OPENAI_API_KEY`。\n\n#### QChatGPT - QQ机器人\n项目主页：https:\u002F\u002Fgithub.com\u002FRockChinQ\u002FQChatGPT\n\n根据[文档](https:\u002F\u002Fqchatgpt.rockchin.top)完成部署后，在 `data\u002Fprovider.json`设置`requester.openai-chat-completions.base-url`为 One API 实例地址，并填写 API Key 到 `keys.openai` 组中，设置 `model` 为要使用的模型名称。\n\n运行期间可以通过`!model`命令查看、切换可用模型。\n\n### 部署到第三方平台\n\u003Cdetails>\n\u003Csummary>\u003Cstrong>部署到 Sealos \u003C\u002Fstrong>\u003C\u002Fsummary>\n\u003Cdiv>\n\n> Sealos 的服务器在国外，不需要额外处理网络问题，支持高并发 & 动态伸缩。\n\n点击以下按钮一键部署（部署后访问出现 404 请等待 3~5 分钟）：\n\n[![Deploy-on-Sealos.svg](https:\u002F\u002Fraw.githubusercontent.com\u002Flabring-actions\u002Ftemplates\u002Fmain\u002FDeploy-on-Sealos.svg)](https:\u002F\u002Fcloud.sealos.io\u002F?openapp=system-fastdeploy?templateName=one-api)\n\n\u003C\u002Fdiv>\n\u003C\u002Fdetails>\n\n\u003Cdetails>\n\u003Csummary>\u003Cstrong>部署到 Zeabur\u003C\u002Fstrong>\u003C\u002Fsummary>\n\u003Cdiv>\n\n> Zeabur 的服务器在国外，自动解决了网络的问题，同时免费的额度也足够个人使用\n\n[![Deploy on Zeabur](https:\u002F\u002Fzeabur.com\u002Fbutton.svg)](https:\u002F\u002Fzeabur.com\u002Ftemplates\u002F7Q0KO3)\n\n1. 首先 fork 一份代码。\n2. 进入 [Zeabur](https:\u002F\u002Fzeabur.com?referralCode=songquanpeng)，登录，进入控制台。\n3. 新建一个 Project，在 Service -> Add Service 选择 Marketplace，选择 MySQL，并记下连接参数（用户名、密码、地址、端口）。\n4. 复制链接参数，运行 ```create database `one-api` ``` 创建数据库。\n5. 然后在 Service -> Add Service，选择 Git（第一次使用需要先授权），选择你 fork 的仓库。\n6. Deploy 会自动开始，先取消。进入下方 Variable，添加一个 `PORT`，值为 `3000`，再添加一个 `SQL_DSN`，值为 `\u003Cusername>:\u003Cpassword>@tcp(\u003Caddr>:\u003Cport>)\u002Fone-api` ，然后保存。 注意如果不填写 `SQL_DSN`，数据将无法持久化，重新部署后数据会丢失。\n7. 选择 Redeploy。\n8. 进入下方 Domains，选择一个合适的域名前缀，如 \"my-one-api\"，最终域名为 \"my-one-api.zeabur.app\"，也可以 CNAME 自己的域名。\n9. 等待部署完成，点击生成的域名进入 One API。\n\n\u003C\u002Fdiv>\n\u003C\u002Fdetails>\n\n\u003Cdetails>\n\u003Csummary>\u003Cstrong>部署到 Render\u003C\u002Fstrong>\u003C\u002Fsummary>\n\u003Cdiv>\n\n> Render 提供免费额度，绑卡后可以进一步提升额度\n\nRender 可以直接部署 docker 镜像，不需要 fork 仓库：https:\u002F\u002Fdashboard.render.com\n\n\u003C\u002Fdiv>\n\u003C\u002Fdetails>\n\n## 配置\n系统本身开箱即用。\n\n你可以通过设置环境变量或者命令行参数进行配置。\n\n等到系统启动后，使用 `root` 用户登录系统并做进一步的配置。\n\n**Note**：如果你不知道某个配置项的含义，可以临时删掉值以看到进一步的提示文字。\n\n## 使用方法\n在`渠道`页面中添加你的 API Key，之后在`令牌`页面中新增访问令牌。\n\n之后就可以使用你的令牌访问 One API 了，使用方式与 [OpenAI API](https:\u002F\u002Fplatform.openai.com\u002Fdocs\u002Fapi-reference\u002Fintroduction) 一致。\n\n你需要在各种用到 OpenAI API 的地方设置 API Base 为你的 One API 的部署地址，例如：`https:\u002F\u002Fopenai.justsong.cn`，API Key 则为你在 One API 中生成的令牌。\n\n注意，具体的 API Base 的格式取决于你所使用的客户端。\n\n例如对于 OpenAI 的官方库：\n```bash\nOPENAI_API_KEY=\"sk-xxxxxx\"\nOPENAI_API_BASE=\"https:\u002F\u002F\u003CHOST>:\u003CPORT>\u002Fv1\"\n```\n\n```mermaid\ngraph LR\n    A(用户)\n    A --->|使用 One API 分发的 key 进行请求| B(One API)\n    B -->|中继请求| C(OpenAI)\n    B -->|中继请求| D(Azure)\n    B -->|中继请求| E(其他 OpenAI API 格式下游渠道)\n    B -->|中继并修改请求体和返回体| F(非 OpenAI API 格式下游渠道)\n```\n\n可以通过在令牌后面添加渠道 ID 的方式指定使用哪一个渠道处理本次请求，例如：`Authorization: Bearer ONE_API_KEY-CHANNEL_ID`。\n注意，需要是管理员用户创建的令牌才能指定渠道 ID。\n\n不加的话将会使用负载均衡的方式使用多个渠道。\n\n### 环境变量\n> One API 支持从 `.env` 文件中读取环境变量，请参照 `.env.example` 文件，使用时请将其重命名为 `.env`。\n1. `REDIS_CONN_STRING`：设置之后将使用 Redis 作为缓存使用。\n   + 例子：`REDIS_CONN_STRING=redis:\u002F\u002Fdefault:redispw@localhost:49153`\n   + 如果数据库访问延迟很低，没有必要启用 Redis，启用后反而会出现数据滞后的问题。\n   + 如果需要使用哨兵或者集群模式：\n     + 则需要把该环境变量设置为节点列表，例如：`localhost:49153,localhost:49154,localhost:49155`。\n     + 除此之外还需要设置以下环境变量：\n       + `REDIS_PASSWORD`：Redis 集群或者哨兵模式下的密码设置。\n       + `REDIS_MASTER_NAME`：Redis 哨兵模式下主节点的名称。\n2. `SESSION_SECRET`：设置之后将使用固定的会话密钥，这样系统重新启动后已登录用户的 cookie 将依旧有效。\n   + 例子：`SESSION_SECRET=random_string`\n3. `SQL_DSN`：设置之后将使用指定数据库而非 SQLite，请使用 MySQL 或 PostgreSQL。\n   + 例子：\n     + MySQL：`SQL_DSN=root:123456@tcp(localhost:3306)\u002Foneapi`\n     + PostgreSQL：`SQL_DSN=postgres:\u002F\u002Fpostgres:123456@localhost:5432\u002Foneapi`（适配中，欢迎反馈）\n   + 注意需要提前建立数据库 `oneapi`，无需手动建表，程序将自动建表。\n   + 如果使用本地数据库：部署命令可添加 `--network=\"host\"` 以使得容器内的程序可以访问到宿主机上的 MySQL。\n   + 如果使用云数据库：如果云服务器需要验证身份，需要在连接参数中添加 `?tls=skip-verify`。\n   + 请根据你的数据库配置修改下列参数（或者保持默认值）：\n     + `SQL_MAX_IDLE_CONNS`：最大空闲连接数，默认为 `100`。\n     + `SQL_MAX_OPEN_CONNS`：最大打开连接数，默认为 `1000`。\n       + 如果报错 `Error 1040: Too many connections`，请适当减小该值。\n     + `SQL_CONN_MAX_LIFETIME`：连接的最大生命周期，默认为 `60`，单位分钟。\n4. `LOG_SQL_DSN`：设置之后将为 `logs` 表使用独立的数据库，请使用 MySQL 或 PostgreSQL。\n5. `FRONTEND_BASE_URL`：设置之后将重定向页面请求到指定的地址，仅限从服务器设置。\n   + 例子：`FRONTEND_BASE_URL=https:\u002F\u002Fopenai.justsong.cn`\n6. `MEMORY_CACHE_ENABLED`：启用内存缓存，会导致用户额度的更新存在一定的延迟，可选值为 `true` 和 `false`，未设置则默认为 `false`。\n   + 例子：`MEMORY_CACHE_ENABLED=true`\n7. `SYNC_FREQUENCY`：在启用缓存的情况下与数据库同步配置的频率，单位为秒，默认为 `600` 秒。\n   + 例子：`SYNC_FREQUENCY=60`\n8. `NODE_TYPE`：设置之后将指定节点类型，可选值为 `master` 和 `slave`，未设置则默认为 `master`。\n   + 例子：`NODE_TYPE=slave`\n9. `CHANNEL_UPDATE_FREQUENCY`：设置之后将定期更新渠道余额，单位为分钟，未设置则不进行更新。\n   + 例子：`CHANNEL_UPDATE_FREQUENCY=1440`\n10. `CHANNEL_TEST_FREQUENCY`：设置之后将定期检查渠道，单位为分钟，未设置则不进行检查。 \n   +例子：`CHANNEL_TEST_FREQUENCY=1440`\n11. `POLLING_INTERVAL`：批量更新渠道余额以及测试可用性时的请求间隔，单位为秒，默认无间隔。\n    + 例子：`POLLING_INTERVAL=5`\n12. `BATCH_UPDATE_ENABLED`：启用数据库批量更新聚合，会导致用户额度的更新存在一定的延迟可选值为 `true` 和 `false`，未设置则默认为 `false`。\n    + 例子：`BATCH_UPDATE_ENABLED=true`\n    + 如果你遇到了数据库连接数过多的问题，可以尝试启用该选项。\n13. `BATCH_UPDATE_INTERVAL=5`：批量更新聚合的时间间隔，单位为秒，默认为 `5`。\n    + 例子：`BATCH_UPDATE_INTERVAL=5`\n14. 请求频率限制：\n    + `GLOBAL_API_RATE_LIMIT`：全局 API 速率限制（除中继请求外），单 ip 三分钟内的最大请求数，默认为 `180`。\n    + `GLOBAL_WEB_RATE_LIMIT`：全局 Web 速率限制，单 ip 三分钟内的最大请求数，默认为 `60`。\n15. 编码器缓存设置：\n    + `TIKTOKEN_CACHE_DIR`：默认程序启动时会联网下载一些通用的词元的编码，如：`gpt-3.5-turbo`，在一些网络环境不稳定，或者离线情况，可能会导致启动有问题，可以配置此目录缓存数据，可迁移到离线环境。\n    + `DATA_GYM_CACHE_DIR`：目前该配置作用与 `TIKTOKEN_CACHE_DIR` 一致，但是优先级没有它高。\n16. `RELAY_TIMEOUT`：中继超时设置，单位为秒，默认不设置超时时间。\n17. `RELAY_PROXY`：设置后使用该代理来请求 API。\n18. `USER_CONTENT_REQUEST_TIMEOUT`：用户上传内容下载超时时间，单位为秒。\n19. `USER_CONTENT_REQUEST_PROXY`：设置后使用该代理来请求用户上传的内容，例如图片。\n20. `SQLITE_BUSY_TIMEOUT`：SQLite 锁等待超时设置，单位为毫秒，默认 `3000`。\n21. `GEMINI_SAFETY_SETTING`：Gemini 的安全设置，默认 `BLOCK_NONE`。\n22. `GEMINI_VERSION`：One API 所使用的 Gemini 版本，默认为 `v1`。\n23. `THEME`：系统的主题设置，默认为 `default`，具体可选值参考[此处](.\u002Fweb\u002FREADME.md)。\n24. `ENABLE_METRIC`：是否根据请求成功率禁用渠道，默认不开启，可选值为 `true` 和 `false`。\n25. `METRIC_QUEUE_SIZE`：请求成功率统计队列大小，默认为 `10`。\n26. `METRIC_SUCCESS_RATE_THRESHOLD`：请求成功率阈值，默认为 `0.8`。\n27. `INITIAL_ROOT_TOKEN`：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量值的 root 用户令牌。\n28. `INITIAL_ROOT_ACCESS_TOKEN`：如果设置了该值，则在系统首次启动时会自动创建一个值为该环境变量的 root 用户创建系统管理令牌。\n29. `ENFORCE_INCLUDE_USAGE`：是否强制在 stream 模型下返回 usage，默认不开启，可选值为 `true` 和 `false`。\n30. `TEST_PROMPT`：测试模型时的用户 prompt，默认为 `Print your model name exactly and do not output without any other text.`。\n\n### 命令行参数\n1. `--port \u003Cport_number>`: 指定服务器监听的端口号，默认为 `3000`。\n   + 例子：`--port 3000`\n2. `--log-dir \u003Clog_dir>`: 指定日志文件夹，如果没有设置，默认保存至工作目录的 `logs` 文件夹下。\n   + 例子：`--log-dir .\u002Flogs`\n3. `--version`: 打印系统版本号并退出。\n4. `--help`: 查看命令的使用帮助和参数说明。\n\n## 演示\n### 在线演示\n注意，该演示站不提供对外服务：\nhttps:\u002F\u002Fopenai.justsong.cn\n\n### 截图展示\n![channel](https:\u002F\u002Fuser-images.githubusercontent.com\u002F39998050\u002F233837954-ae6683aa-5c4f-429f-a949-6645a83c9490.png)\n![token](https:\u002F\u002Fuser-images.githubusercontent.com\u002F39998050\u002F233837971-dab488b7-6d96-43af-b640-a168e8d1c9bf.png)\n\n## 常见问题\n1. 额度是什么？怎么计算的？One API 的额度计算有问题？\n   + 额度 = 分组倍率 * 模型倍率 * （提示 token 数 + 补全 token 数 * 补全倍率）\n   + 其中补全倍率对于 GPT3.5 固定为 1.33，GPT4 为 2，与官方保持一致。\n   + 如果是非流模式，官方接口会返回消耗的总 token，但是你要注意提示和补全的消耗倍率不一样。\n   + 注意，One API 的默认倍率就是官方倍率，是已经调整过的。\n2. 账户额度足够为什么提示额度不足？\n   + 请检查你的令牌额度是否足够，这个和账户额度是分开的。\n   + 令牌额度仅供用户设置最大使用量，用户可自由设置。\n3. 提示无可用渠道？\n   + 请检查的用户分组和渠道分组设置。\n   + 以及渠道的模型设置。\n4. 渠道测试报错：`invalid character '\u003C' looking for beginning of value`\n   + 这是因为返回值不是合法的 JSON，而是一个 HTML 页面。\n   + 大概率是你的部署站的 IP 或代理的节点被 CloudFlare 封禁了。\n5. ChatGPT Next Web 报错：`Failed to fetch`\n   + 部署的时候不要设置 `BASE_URL`。\n   + 检查你的接口地址和 API Key 有没有填对。\n   + 检查是否启用了 HTTPS，浏览器会拦截 HTTPS 域名下的 HTTP 请求。\n6. 报错：`当前分组负载已饱和，请稍后再试`\n   + 上游渠道 429 了。\n7. 升级之后我的数据会丢失吗？\n   + 如果使用 MySQL，不会。\n   + 如果使用 SQLite，需要按照我所给的部署命令挂载 volume 持久化 one-api.db 数据库文件，否则容器重启后数据会丢失。\n8. 升级之前数据库需要做变更吗？\n   + 一般情况下不需要，系统将在初始化的时候自动调整。\n   + 如果需要的话，我会在更新日志中说明，并给出脚本。\n9. 手动修改数据库后报错：`数据库一致性已被破坏，请联系管理员`？\n   + 这是检测到 ability 表里有些记录的渠道 id 是不存在的，这大概率是因为你删了 channel 表里的记录但是没有同步在 ability 表里清理无效的渠道。\n   + 对于每一个渠道，其所支持的模型都需要有一个专门的 ability 表的记录，表示该渠道支持该模型。\n\n## 相关项目\n* [FastGPT](https:\u002F\u002Fgithub.com\u002Flabring\u002FFastGPT): 基于 LLM 大语言模型的知识库问答系统\n* [ChatGPT Next Web](https:\u002F\u002Fgithub.com\u002FYidadaa\u002FChatGPT-Next-Web):  一键拥有你自己的跨平台 ChatGPT 应用\n* [VChart](https:\u002F\u002Fgithub.com\u002FVisActor\u002FVChart):  不只是开箱即用的多端图表库，更是生动灵活的数据故事讲述者。\n* [VMind](https:\u002F\u002Fgithub.com\u002FVisActor\u002FVMind):  不仅自动，还很智能。开源智能可视化解决方案。\n* [CherryStudio](https:\u002F\u002Fgithub.com\u002FCherryHQ\u002Fcherry-studio):  全平台支持的AI客户端, 多服务商集成管理、本地知识库支持。\n\n## 注意\n\n本项目使用 MIT 协议进行开源，**在此基础上**，必须在页面底部保留署名以及指向本项目的链接。如果不想保留署名，必须首先获得授权。\n\n同样适用于基于本项目的二开项目。\n\n依据 MIT 协议，使用者需自行承担使用本项目的风险与责任，本开源项目开发者与此无关。\n","One API 是一个LLM API管理和分发系统，支持多种主流大模型如OpenAI、Azure、Anthropic Claude等，并提供统一的API适配。其核心功能包括多模型支持、API统一管理与二次分发，以及通过单个可执行文件或Docker镜像实现的一键部署。该系统适用于需要跨平台调用不同大语言模型的应用场景，例如开发基于AI的聊天机器人、文本生成工具等。采用JavaScript编写，遵循MIT License开源协议。",2,"2026-06-11 02:46:46","top_all"]