跳到主要内容

公共 API

Libre WebUI 提供兼容 OpenAI 的 API,因此现有 SDK、编辑器和脚本只需更改基础 URL,便可指向你的实例。

身份验证

在“设置 → 账户 → API 令牌”中创建限定作用域的 API 令牌(令牌以 lwk_ 开头,并以哈希形式存储)。/v1 接口要求 chat 作用域。按普通 bearer 密钥 方式传递令牌:

export OPENAI_BASE_URL="https://your-instance/v1"
export OPENAI_API_KEY="lwk_..."

请求受单令牌速率限制(每分钟 600 个请求)和共享聊天速率限制约束。

端点

端点用途
GET /v1/models可用模型(本地或由提供商插件支持)
POST /v1/chat/completions无状态聊天补全,支持流式或非流式

POST /v1/chat/completions 接受熟悉的请求体:modelmessagessystem/user/assistant;多模态文本部分会被展平)、streamtemperaturetop_pmax_tokens/max_completion_tokensseedstop。流式响应是 chat.completion.chunk SSE 帧,以 data: [DONE] 结束;非流式响应在提供商报告 用量时包含 usage 令牌计数。

curl "$OPENAI_BASE_URL/chat/completions" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "llama3.2",
"messages": [{"role": "user", "content": "One sentence on herons."}]
}'

明确边界

/v1 接口用于无状态推理:它绝不会创建聊天、触碰知识库或运行工具。 具有持久可重放事件、按身份取消、幂等入队和原生工具循环的有状态会话位于原生 /api/chat 事件 API;同一令牌可通过 chat 作用域调用。除 system/user/assistant 外的角色(如 tool)会被拒绝,而不是静默接受。

相关文档