OpenWebUI如何对外提供HTTP接口？

优质文章学习记录

— 9 min read
OpenWebUI如何对外提供HTTP接口？

from 公众号：程序员more

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

01 OpenWebUI配置app key

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

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

02 API使用说明

注意每次请求都需要将API KEY密钥设置到HTTP请求头

Authorization: Bearer eyJhbGci***

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

接口作用

列出所有已经配置在OpenWebUI的模型

地址

/api/models

方法

GET

请求示例

127.0.0.1:3000/api/models

响应结果

{ "data": [{ "id": "deepseek-r1:1.5b", "name": "deepseek-r1:1.5b", "object": "model", "created": 1741313196, "owned_by": "ollama", "ollama": { "name": "deepseek-r1:1.5b", "model": "deepseek-r1:1.5b", "modified_at": "2025-02-26T09:59:46.3066414+08:00", "size": 1117322599, "digest": "a42b25d8c10a841bd24724309898ae851466696a7d7f3a0a408b895538ccbc96", "details": { "parent_model": "", "format": "gguf", "family": "qwen2", "families": ["qwen2"], "parameter_size": "1.8B", "quantization_level": "Q4_K_M" }, "urls": [0] }, "actions": [] }]}

以下是简单的聊天调用，文章下面会介绍关联知识库的聊天调用方式

接口作用

调用后端模型进行聊天

地址

/api/chat/completions

方法

POST

请求示例

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

参数说明

model

/api/models接口返回的模型id

role

user=⽤户输⼊

assistant=AI助⼿的回复

system=系统，即设定AI的⾏为

tool=⼯具调⽤返回值

content

提问内容

响应结果

{    "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": "<think>\n\n</think>\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        }    }}

参数说明

message.content

响应内容

 聊天中使用流式响应

接口作用

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

地址

/api/chat/completions

方法

POST

请求示例

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

响应结果

图片

数据以流式响应：

data: {"id": "deepseek-r1:1.5b-fc918971-baab-4f2f-a359-cafb9c104ab2", "created": 1741331179, "model": "deepseek-r1:1.5b", "choices": [{"index": 0, "logprobs": null, "finish_reason": null, "delta": {"content": "\u7684\u5173\u952e"}}], "object": "chat.completion.chunk"}

……

data: {"id": "deepseek-r1:1.5b-0fae48d0-162d-4cef-ba42-54ef12a27c4f", "created": 1741331179, "model": "deepseek-r1:1.5b", "choices": [{"index": 0, "logprobs": null, "finish_reason": null, "delta": {"content": "\u3002"}}], "object": "chat.completion.chunk"}

……

data: {"id": "deepseek-r1:1.5b-33a7f78c-0052-47d7-a674-0560458b8107", "created": 1741331179, "model": "deepseek-r1:1.5b", "choices": [{"index": 0, "logprobs": null, "finish_reason": "stop", "delta": {}}], "object": "chat.completion.chunk", "usage": {"response_token/s": 20.83, "prompt_token/s": 52.63, "total_duration": 99595060200, "load_duration": 1483943500, "prompt_eval_count": 5, "prompt_tokens": 5, "prompt_eval_duration": 95000000, "eval_count": 2042, "completion_tokens": 2042, "eval_duration": 98014000000, "approximate_total": "0h1m39s", "total_tokens": 2047, "completion_tokens_details": {"reasoning_tokens": 0, "accepted_prediction_tokens": 0, "rejected_prediction_tokens": 0}}}

……

data: [DONE]

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

接口作用

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

地址

/api/chat/completions

方法

POST

请求参数指定知识文件

{      "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"}      ]}

接下来了解知识库上传相关API。

03 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}

响应结果

{    "id": "知识库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/

请求参数

文件以二进制流上传

请求头：content-type:multipart/form-data;

响应结果

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

id对应/api/v1/knowledge/create接口响应的知识库id

请求参数

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

file_id对应/api/v1/files接口响应的id

响应结果

{    "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": [        {            "id": "77cb080c-5de8-4ffb-9304-d658e44a4dfb",            "user_id": "e42bf055-03e4-421e-894d-c18a58b6b73d",            "hash": "93737981707e6327ca3adf45a7ae11bfd33bc7fcbb0de82c85c390efa1a2f01c",            "filename": "日志.txt",            "path": "/app/backend/data/uploads/77cb080c-5de8-4ffb-9304-d658e44a4dfb_日志.txt",            "data": {                "content": "文件内容"            },            "meta": {                "name": "日志.txt",                "content_type": "text/plain",                "size": 5587,                "data": {},                "collection_name": "e13f471f-cc6c-4df1-9210-8eb586bf8b6b"            },            "access_control": null,            "created_at": 1741317221,            "updated_at": 1741317221        }    ]}

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

如果想了解其他的接口我们可以通过在浏览器打开调试窗口查看网络调用情况。

Read more

Web 请求到底为什么是I/O 密集型的庖丁解牛

“Web 请求是 I/O 密集型” 是后端开发的核心认知，但许多 PHP 程序员仅停留在口号层面。 一、Web 请求的完整生命周期（以 Laravel 为例） RedisMySQLPHP-FPMNginxClientRedisMySQLPHP-FPMNginxClientHTTP RequestFastCGI RequestSELECT * FROM users WHERE id=100Result SetGET user:100:profileProfile DataHTML/JSON ResponseHTTP Response ✅ 关键观察： PHP 代码执行时间 ≈ 10–50ms， I/O 等待时间 ≈ 50–200ms（数据库 + 缓存 + 网络） 二、I/O 密集型的本质：CPU 在等待

V8与WebKit揭秘：现代浏览器引擎漏洞在Web渗透中的高级利用实战

前言 1. 技术背景：在现代Web攻防体系中，浏览器本身已成为一个关键的攻击入口。传统的Web渗透测试（如XSS、CSRF、SQL注入）主要聚焦于服务器端应用的漏洞，而针对客户端的攻击则往往依赖于浏览器引擎的复杂性。V8（用于Chrome和Edge）和WebKit（用于Safari）作为最主流的浏览器引擎，其内部的JIT编译器、垃圾回收机制等模块异常复杂，不可避免地会产生类型混淆 (Type Confusion)、越界读写 (OOB) 等内存安全漏洞。利用这些漏洞，攻击者可以突破浏览器的沙箱 (Sandbox) 限制，实现从一个网页标签页的JavaScript执行环境，跃迁到对用户操作系统的完全控制，即实现远程代码执行 (RCE)。这种攻击模式是对传统Web攻击的降维打击，它将原本局限于Web应用层面的风险，直接升级为对终端主机的系统级威胁。 2. 学习价值：掌握浏览器引擎漏洞的利用技术，意味着你将能够： * 理解攻击的本质：从内存层面理解JavaScript代码如何被执行，以及看似无害的操作为何能触发致命漏洞。 * 提升漏洞挖掘能力：学会使用**Fuzzing（

Web Server for Chrome终极指南：5分钟搭建本地Web开发环境

Web Server for Chrome终极指南：5分钟搭建本地Web开发环境 【免费下载链接】web-server-chromeAn HTTP Web Server for Chrome (chrome.sockets API) 项目地址: https://gitcode.com/gh_mirrors/we/web-server-chrome 还在为复杂的本地服务器配置而头疼吗？想要一个简单快捷的方式来预览网页项目或共享文件吗？Web Server for Chrome正是你需要的解决方案。这款基于Chrome浏览器的轻量级HTTP服务器，让本地Web开发变得前所未有的简单。 为什么选择Web Server for Chrome？ 传统的本地服务器搭建往往需要安装Node.js、Python等运行环境，配置过程繁琐复杂。Web Server for Chrome彻底改变了这一现状，它直接在Chrome浏览器中运行，无需任何外部依赖，真正实现了开箱即用。 核心优势： * 🚀 零配置启动，几秒钟内即可运行 * 💻 跨平台兼容，
前端小白也能秒上手：JS生成UUID的10种姿势（附避坑指南）

前端小白也能秒上手：JS生成UUID的10种姿势（附避坑指南）

前端小白也能秒上手：JS生成UUID的10种姿势（附避坑指南） * 前端小白也能秒上手：JS生成UUID的10种姿势（附避坑指南） * 为啥前端突然要搞这破玩意儿？还不是被后端逼的 * 先整明白UUID到底是个啥，别瞎用 * 土法炼钢第一式：Math.random()真的靠谱吗？ * 土法炼钢第二式：Date.now()加料版 * 土法炼钢第三式：浏览器指纹大杂烩 * 正规军来了：uuid npm包到底香不香？ * 浏览器原生API：crypto.randomUUID()真香预警 * 生产环境翻车实录：那些我以为的唯一其实并不唯一 * 实战代码大放送：这些场景你肯定用得上 * 调试技巧：怎么验证你的UUID真的唯一？ * 冷门但好用的小技巧 * 最后唠叨两句，也是掏心窝子的话 前端小白也能秒上手：JS生成UUID的10种姿势（附避坑指南） 说实话啊，这篇文章我原本是不想写的。真的，因为UUID这玩意儿听起来就挺"后端味儿"的，感觉应该是那帮穿格子衫的Java老哥在Spring Boot里@Genera