OpenWebUI 对外提供 HTTP 接口的配置与使用

OpenWebUI 如何通过 HTTP 接口对外提供服务。内容包括配置 Bearer Token 认证、调用聊天接口（含流式响应）、以及在请求中附带知识库文件的方法。此外，还详细说明了 RAG 功能的实现流程，包括创建知识库、上传文件及关联文件的 API 接口参数与响应格式，帮助开发者快速集成模型能力。

ArchDesign发布于 2026/4/6更新于 2026/4/131 浏览

OpenWebUI 通过 HTTP 方式提供对外接口，使得开发者可以通过 HTTP 方式快速对接拥有 RAG 能力的模型基座。

1. 配置 API Key

OpenWebUI 使用 Bearer Token 机制对 API 请求进行身份验证。从 Open WebUI 中的'设置 > 帐户'获取 API 密钥，或者使用 JWT（JSON Web 令牌）进行身份验证。

其中 JWT 是有时效性限制，API 密钥是永久的。

2. API 使用说明

注意每次请求都需要将 API KEY 密钥设置到 HTTP 请求头： Authorization: Bearer <your_api_key>

基础接口功能包括列出在 OpenWebUI 注册的模型和模型进行聊天。

列出模型

接口作用	列出所有已经配置在 OpenWebUI 的模型
地址	`/api/models`
方法	`GET`
请求示例	`127.0.0.1:3000/api/models`
响应结果	```json
{
"data": [

{
  "id": "deepseek-r1:1.5b",
  "name": "deepseek-r1:1.5b",
  "object": "model",
  "created": 1741313196,
  "owned_by": "ollama",
  "ollama": {
    "name": "deepseek-r1:1.5b"

相关免费在线工具

RSA密钥对生成器
生成新的随机RSA私钥和公钥pem证书。在线工具，RSA密钥对生成器在线工具，online
Mermaid 预览与可视化编辑
基于 Mermaid.js 实时预览流程图、时序图等图表，支持源码编辑与即时渲染。在线工具，Mermaid 预览与可视化编辑在线工具，online
Base64 字符串编码/解码
将字符串编码和解码为其 Base64 格式表示形式即可。在线工具，Base64 字符串编码/解码在线工具，online
Base64 文件转换器
将字符串、文件或图像转换为其 Base64 表示形式。在线工具，Base64 文件转换器在线工具，online
Markdown 转 HTML
将 Markdown（GFM）转为 HTML 片段，浏览器内 marked 解析；与 HTML 转 Markdown 互为补充。在线工具，Markdown 转 HTML在线工具，online
HTML 转 Markdown
将 HTML 片段转为 GitHub Flavored Markdown，支持标题、列表、链接、代码块与表格等；浏览器内处理，可链接预填。在线工具，HTML 转 Markdown在线工具，online


### 调用后端模型进行聊天
| 接口作用 | 调用后端模型进行聊天 |
| :--- | :--- |
| 地址 | `/api/chat/completions` |
| 方法 | `POST` |
| 请求示例 | ```json
{
  "model": "deepseek-r1:1.5b",
  "messages": [
    {
      "role": "user",
      "content": "你好啊"
    }
  ]
}
``` |
| 参数说明 | model: /api/models 接口返回的模型 id<br>role: user=用户输入, assistant=AI 助手的回复, system=系统设定, tool=工具调用返回值<br>content: 提问内容 |
| 响应结果 | ```json
{
  "id": "deepseek-r1:1.5b-09322e4f-ba07-42fc-894c-c64424240670",
  "created": 1741313942,
  "model": "deepseek-r1:1.5b",
  "choices": [
    {
      "index": 0,
      "logprobs": null,
      "finish_reason": "stop",
      "message": {
        "content": "\n\n你好！很高兴见到你，有什么我可以帮忙的吗？",
        "role": "assistant"
      }
    }
  ],
  "object": "chat.completion",
  "usage": {
    "response_token/s": 22.73,
    "prompt_token/s": 41.32,
    "total_duration": 890745200,
    "load_duration": 19290900,
    "prompt_eval_count": 5,
    "prompt_tokens": 5,
    "prompt_eval_duration": 121000000,
    "eval_count": 17,
    "completion_tokens": 17,
    "eval_duration": 748000000,
    "approximate_total": "0h0m0s",
    "total_tokens": 22,
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}
``` |

### 流式响应
在聊天中使用流式响应，结果不是一次性返回，而是分段返回，参数中设置 `stream` 等于 `true`。

| 接口作用 | 在聊天中使用流式响应 |
| :--- | :--- |
| 地址 | `/api/chat/completions` |
| 方法 | `POST` |
| 请求示例 | ```json
{
  "model": "deepseek-r1:1.5b",
  "messages": [
    {
      "role": "user",
      "content": "什么是 java"
    }
  ],
  "stream": true
}
``` |
| 响应结果 | 数据以流式响应返回，例如：


### 请求中附带知识库文件
| 接口作用 | 请求中附带知识库文件或者知识库集合 |
| :--- | :--- |
| 地址 | `/api/chat/completions` |
| 方法 | `POST` |
| 指定知识文件 | ```json
{
  "model": "gpt-4-turbo",
  "messages": [{"role": "user", "content": "Explain the concepts in this document."}],
  "files": [{"type": "file", "id": "your-file-id-here"}]
}
``` |
| 指定知识集合 | ```json
{
  "model": "gpt-4-turbo",
  "messages": [{"role": "user", "content": "Provide insights on the historical perspectives covered in the collection."}],
  "files": [{"type": "collection", "id": "your-collection-id-here"}]
}
``` |

## 3. RAG 部分

Retrieval Augmented Generation (RAG) 功能通过整合外部来源的数据来增强响应。下面将说明知识库创建与知识库数据上传相关接口，如没有说明统一的请求头 `Content-Type=application/json`。

上传知识库的流程:
1. 创建知识库，接口：`/api/v1/knowledge/create`；
2. 上传知识库文件，接口：`/api/v1/files/`；
3. 关联知识库与知识库文件，接口：`/api/v1/knowledge/{知识库 id}/file/add`。

### 创建知识库
| 接口 | POST `/api/v1/knowledge/create` |
| :--- | :--- |
| 请求参数 | `{"name":"知识库名称","description":"知识库说明","access_control":null}` |
| 响应结果 | ```json
{
  "id": "e13f471f-cc6c-4df1-9210-8eb586bf8b6b",
  "user_id": "e42bf055-03e4-421e-894d-c18a58b6b73d",
  "name": "test",
  "description": "for test",
  "data": null,
  "meta": null,
  "access_control": null,
  "created_at": 1741317031,
  "updated_at": 1741317031,
  "files": null
}
``` |

### 上传知识库文件
| 接口 | POST `/api/v1/files/` |
| :--- | :--- |
| 请求参数 | 文件以二进制流上传<br>请求头：`content-type: multipart/form-data;` |
| 响应结果 | ```json
{
  "id": "77cb080c-5de8-4ffb-9304-d658e44a4dfb",
  "user_id": "e42bf055-03e4-421e-894d-c18a58b6b73d",
  "hash": "93737981707e6327ca3adf45a7ae11bfd33bc7fcbb0de82c85c390efa1a2f01c",
  "filename": "日志.txt",
  "data": {"content": "文件上传内容"},
  "meta": {
    "name": "日志.txt",
    "content_type": "text/plain",
    "size": 5587,
    "data": {},
    "collection_name": "file-77cb080c-5de8-4ffb-9304-d658e44a4dfb"
  },
  "created_at": 1741317221,
  "updated_at": 1741317221
}
``` |

### 关联知识库与文件
| 接口 | POST `/api/v1/knowledge/{id}/file/add` |
| :--- | :--- |
| 请求参数 | `{"file_id":"77cb080c-5de8-4ffb-9304-d658e44a4dfb"}` |
| 响应结果 | ```json
{
  "id": "e13f471f-cc6c-4df1-9210-8eb586bf8b6b",
  "user_id": "e42bf055-03e4-421e-894d-c18a58b6b73d",
  "name": "test",
  "description": "for test",
  "data": {
    "file_ids": ["77cb080c-5de8-4ffb-9304-d658e44a4dfb"]
  },
  "meta": null,
  "access_control": null,
  "created_at": 1741317031,
  "updated_at": 1741317226,
  "files": [...]
}
``` |

如果想实现多轮会话，可以看 `/api/v1/chats/{chat_id}`，它主要负责管理会话，包括查询（GET）、新增（POST），主要通过 `chat_id` 关联 `/api/chat/completions`。

OpenWebUI 对外提供 HTTP 接口的配置与使用

1. 配置 API Key

2. API 使用说明

列出模型

微信扫一扫，关注极客日志

更多推荐文章

相关免费在线工具