跳到正文
RunAPI 开发者文档
开发者资源
开发者资源

Open WebUI

安装 Open WebUI,将 RunAPI 添加为 OpenAI-compatible Connection,选择模型并验证聊天。

通过 Open WebUI 的 OpenAI-compatible Connection 连接 RunAPI。开始前需要 Open WebUI 管理员权限,并从身份验证指南创建标准 RunAPI API Key。

安装 Open WebUI

按照 Open WebUI 官方快速开始选择适合你的安装方式。本地 Docker 安装可使用官方镜像:

SHELL
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main

打开应用,创建管理员账户并登录,然后再添加 Connection。

添加 RunAPI Connection

  1. 打开 Admin Settings → Connections → OpenAI,然后选择 Add Connection
  2. URL 填写 https://runapi.ai/v1,API Key 填写 RunAPI Key。
  3. 第一次连接时将 Model IDs (Filter) 留空,让 Open WebUI 自动发现可用模型。
  4. 保存 Connection,等待验证完成。

Open WebUI 从 backend 发起连接检查,并通过 GET /v1/models 发现模型。RunAPI URL 是公开 HTTPS 地址,因此 Docker 安装连接 RunAPI 时不需要 host.docker.internal

选择模型

新建 chat,在 chat model selector 中选择一个 RunAPI model。使用模型目录确认当前 model identifier 和能力。

若自动发现没有填充 selector,请编辑 Connection,在 Model IDs (Filter) 中加入准确 identifier。模型发现失败与 Chat Completions 失败是两个独立信号;删除 Connection 前,应先测试手动添加的 model。

验证连接

发送简短提示,例如 只回复 connected。。收到正常的流式或完整响应,即表示 Open WebUI 可以使用所选 RunAPI model。

排查问题

  • 验证返回 401403 使用身份验证指南中的有效标准 Key 替换 Connection 内的 API Key。
  • 没有出现 RunAPI model: 确认 URL 以 /v1 结尾,然后在 Model IDs (Filter) 中加入一个当前 identifier 并重试 chat。
  • model 可见但 chat 失败:模型目录确认该 identifier 支持 OpenAI-compatible Chat Completions,再检查 Open WebUI backend logs 中的请求状态。
  • 本地 URL 在浏览器可用,但 Open WebUI 无法连接: Open WebUI Connection 从 backend 发请求。公开的 https://runapi.ai/v1 不受影响,但其他本地 Connection 需要考虑容器网络。

通用协议行为请查看 LLM API 快速开始。请求和响应字段请查看 Chat Completions API 参考