API 文档

WeiLinkBot 提供 RESTful API 接口和 WebSocket 实时推送，方便程序化管理。

基础信息

• 基础地址: http://localhost:5292
• 数据格式: JSON
• 认证方式: 暂无（本地运行）

机器人控制

方法	路径	说明
GET	/api/bot/status	机器人状态
POST	/api/bot/start	启动机器人
POST	/api/bot/stop	停止机器人

提供商管理

方法	路径	说明
GET	/api/providers	获取提供商列表
POST	/api/providers	创建提供商
PUT	/api/providers/{id}	更新提供商
DELETE	/api/providers/{id}	删除提供商

LLM 预设管理

方法	路径	说明
GET	/api/models	获取 LLM 预设列表
POST	/api/models	创建 LLM 预设
PUT	/api/models/{id}	更新 LLM 预设
DELETE	/api/models/{id}	删除 LLM 预设
POST	/api/models/{id}/activate	激活预设

会话管理

方法	路径	说明
GET	/api/conversations	获取会话列表
GET	/api/conversations/{user_id}	获取用户消息记录
DELETE	/api/conversations/{user_id}	清空用户历史记录

系统提示词

方法	路径	说明
GET	/api/prompts	获取提示词列表
POST	/api/prompts	创建提示词
PUT	/api/prompts/{id}	更新提示词
DELETE	/api/prompts/{id}	删除提示词

ST 预设

方法	路径	说明
GET	/api/st-presets	获取 ST 预设列表
POST	/api/st-presets	创建 ST 预设
PUT	/api/st-presets/{id}	更新 ST 预设
DELETE	/api/st-presets/{id}	删除 ST 预设
POST	/api/st-presets/{id}/activate	激活 ST 预设
POST	/api/st-presets/{id}/entries	添加预设条目
PUT	/api/st-presets/entries/{entry_id}	更新预设条目
DELETE	/api/st-presets/entries/{entry_id}	删除预设条目
PUT	/api/st-presets/{id}/reorder	重排序条目

世界书

方法	路径	说明
GET	/api/world-books	获取世界书列表
POST	/api/world-books	创建世界书
PUT	/api/world-books/{id}	更新世界书
DELETE	/api/world-books/{id}	删除世界书
POST	/api/world-books/{id}/activate	激活世界书
POST	/api/world-books/{id}/entries	添加世界书条目
PUT	/api/world-books/entries/{entry_id}	更新世界书条目
DELETE	/api/world-books/entries/{entry_id}	删除世界书条目
PUT	/api/world-books/{id}/reorder	重排序条目

角色卡

方法	路径	说明
GET	/api/characters	获取角色卡列表
POST	/api/characters	创建角色卡
PUT	/api/characters/{id}	更新角色卡
DELETE	/api/characters/{id}	删除角色卡
POST	/api/characters/{id}/activate	激活角色卡

记忆系统

方法	路径	说明
GET	/api/memories/status	记忆系统状态
GET	/api/memories/config	获取记忆配置
PUT	/api/memories/config	更新记忆配置
POST	/api/memories/config/test	测试 Embedding 连接
GET	/api/memories/{user_id}	获取用户记忆
GET	/api/memories/{user_id}/search	语义搜索记忆
GET	/api/memories/{user_id}/summaries	获取用户对话摘要
DELETE	/api/memories/summaries/{id}	删除单条摘要
DELETE	/api/memories/summaries/user/{user_id}	清空用户摘要
GET	/api/memories/export	导出记忆 JSON
POST	/api/memories/import	导入记忆 JSON

Agent 配置

方法	路径	说明
GET	/api/agent/config	获取 Agent 配置
PUT	/api/agent/config	更新 Agent 配置

系统

方法	路径	说明
GET	/api/users	获取用户列表
PUT	/api/users/{user_id}	更新用户信息
GET	/api/settings	获取系统设置
PUT	/api/settings	更新系统设置
GET	/api/stats	获取统计信息

实时通信

SSE 事件流

GET /api/events

Server-Sent Events 端点，推送机器人状态变更、消息事件等实时信息。

WebSocket

WS /ws

WebSocket 端点，用于前端控制台的实时数据推送，包括机器人状态、消息更新等。

Swagger 文档

启动服务后，访问以下地址查看自动生成的 API 文档：

http://localhost:5292/docs

或查看 ReDoc 格式：

http://localhost:5292/redoc