OpenWebUI 对外 HTTP 接口使用指南

2.2 调用模型聊天

请求参数说明：

• model: /api/models 接口返回的模型 id
• messages: 消息列表，包含 role (user/assistant/system) 和 content (提问内容)

请求示例：

{
 "model": "deepseek-r1:1.5b",
 "messages": [
 {
 "role": "user",
 "content": "你好啊"
 }
 ]
}

响应结果：

{
 "id": "deepseek-r1:1.5b-...",
 "choices": [
 {
 "message": {
 "content": "你好！很高兴见到你...",
 "role": "assistant"
 }
 }
 ],
 "usage": {
 "total_tokens": 22
 }
}

2.3 流式响应

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

请求示例：

{
 "model": "deepseek-r1:1.5b",
 "messages": [
 {
 "role": "user",
 "content": "什么是 java"
 }
 ],
 "stream": true
}

响应结果：

数据以流式响应格式返回，每行以 data: 开头，最后以 [DONE] 结束。

2.4 知识库关联

请求中可附带知识库文件或者知识库集合。

指定知识文件：

{
 "model": "gpt-4-turbo",
 "messages": [
 {"role": "user", "content": "Explain the concepts in this document."}
 ],
 "files": [
 {"type": "file", "id": "your-file-id-here"}
 ]
}

指定知识集合：

{
 "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。

3.1 创建知识库

接口： POST /api/v1/knowledge/create

请求参数：

{"name":"知识库名称","description":"知识库说明","access_control":null}

响应结果：

{
 "id": "e13f471f-cc6c-4df1-9210-8eb586bf8b6b",
 "name": "test",
 "description": "for test",
 "created_at": 1741317031
}

3.2 上传知识库文件

接口： POST /api/v1/files/

请求参数： 文件以二进制流上传，请求头 content-type: multipart/form-data;

响应结果：

{
 "id": "77cb080c-5de8-4ffb-9304-d658e44a4dfb",
 "filename": "日志.txt",
 "meta": {
 "size": 5587
 }
}

3.3 关联知识库与文件

接口： POST /api/v1/knowledge/{id}/file/add

请求参数：

{"file_id":"77cb080c-5de8-4ffb-9304-d658e44a4dfb"}

响应结果：

{
 "id": "e13f471f-cc6c-4df1-9210-8eb586bf8b6b",
 "data": {
 "file_ids": ["77cb080c-5de8-4ffb-9304-d658e44a4dfb"]
 }
}

多轮会话可通过 /api/v1/chats/{chat_id} 管理，主要通过 chat_id 关联 /api/chat/completions。