# LangBot HTTP API ## API Docs - logs [获取日志](https://ok52vhsenr.apifox.cn/api-222497611.md): - stats [获取基本统计数据](https://ok52vhsenr.apifox.cn/api-231902041.md): - system [获取系统信息](https://ok52vhsenr.apifox.cn/api-222908269.md): 获取系统当前状态信息,如是否处于调试模式、版本号 - system [获取异步任务列表](https://ok52vhsenr.apifox.cn/api-227539225.md): LangBot 内部使用自实现的一个异步任务队列来管理诸如插件安装、模块重载、插件更新等异步任务。 - system [获取指定任务的信息](https://ok52vhsenr.apifox.cn/api-227634156.md): 查看单个异步任务的信息,结构与 获取异步任务列表 相似。webui可以在发起任务(插件安装、更新、卸载等)后,使用当时返回的任务id轮询此接口来跟踪任务。 - system [执行调试代码](https://ok52vhsenr.apifox.cn/api-234275884.md): 仅在调试模式允许使用 - system [执行热重载](https://ok52vhsenr.apifox.cn/api-234280481.md): - settings [获取已注册的配置管理器列表](https://ok52vhsenr.apifox.cn/api-222908697.md): - settings [获取配置管理器详细信息](https://ok52vhsenr.apifox.cn/api-222916555.md): - settings [修改配置管理器内容](https://ok52vhsenr.apifox.cn/api-223116340.md): - plugins [获取已加载的插件列表](https://ok52vhsenr.apifox.cn/api-223866092.md): 保证 author/name 唯一。 - plugins [获取已加载的插件的信息](https://ok52vhsenr.apifox.cn/api-224679680.md): 使用author/plugin_name唯一确定某个插件,数据结构与 获取已加载的插件列表 相同。 - plugins [获取插件配置](https://ok52vhsenr.apifox.cn/api-283272211.md): 插件的配置是单独存储的,插件配置schema可以在插件信息找到。插件配置是提供给用户设置的,需要渲染成前端表单。 - plugins [修改插件配置](https://ok52vhsenr.apifox.cn/api-283273813.md): 需要根据插件信息中的config_schema渲染配置表单,将表单值作为此接口body传入。 - plugins [切换插件启用/禁用状态](https://ok52vhsenr.apifox.cn/api-224816903.md): 启用或禁用插件,前端无需考虑脏值问题,只需要根据用户操作(比如点击了一个“启用插件”按钮,此时不管后端中插件的状态是启用还是禁用,其状态在调用此接口后都应为启用)设置目标状态,这对于用户来说也是直观的。 - plugins [重新排序(修改优先级)](https://ok52vhsenr.apifox.cn/api-224907667.md): 对插件进行排序,本质上就是修改priority,前端应该构造一个允许用户排序的列表,并在调用接口时生成各个插件的priority,priority越小的插件越靠前。不强制要求完整性(也就是说可以仅提供部分插件在body中) - plugins [更新插件](https://ok52vhsenr.apifox.cn/api-227624266.md): 发起插件更新任务,返回异步任务id。 - plugins [从 GitHub 仓库安装插件](https://ok52vhsenr.apifox.cn/api-229518070.md): body中的source参数即为插件的github仓库地址,示例仓库 https://github.com/langbot-app/NahidaNewDemo - plugins [删除插件](https://ok52vhsenr.apifox.cn/api-231899065.md): 发起插件删除任务,返回异步任务id,响应结构可以参考 更新插件 接口。 - plugins [获取插件市场插件列表](https://ok52vhsenr.apifox.cn/api-290591612.md): - user [获取是否已经初始化](https://ok52vhsenr.apifox.cn/api-234458275.md): 需要在访问前端时调用,如果响应为initialized=false,那么代表此实例还没有初始化账户,需要跳转到独立的账户初始化页。如果已经初始化,则跳转到账户登录页,或者根据浏览器存储的jwt token调用刷新token的接口。 - user [创建初始账户](https://ok52vhsenr.apifox.cn/api-234458411.md): 仅允许在未初始化的状态创建初始账户。 - user [检查账户并签发token](https://ok52vhsenr.apifox.cn/api-234458431.md): 登录用。 - user [检查并刷新token](https://ok52vhsenr.apifox.cn/api-234478760.md): 在auth中带上之前签发的jwt token,如果jwt token已失效,则会401,此时应该跳转到登录页;如果正常返回200,则表示jwt仍有效,并将返回新签发的token; - provider > models > llm [获取 LLM 模型列表](https://ok52vhsenr.apifox.cn/api-266147697.md): - provider > models > llm [添加 LLM 模型](https://ok52vhsenr.apifox.cn/api-266148236.md): - provider > models > llm [获取 LLM 模型详细信息](https://ok52vhsenr.apifox.cn/api-266148424.md): - provider > models > llm [删除 LLM 模型](https://ok52vhsenr.apifox.cn/api-266148484.md): - provider > models > llm [修改 LLM 模型信息](https://ok52vhsenr.apifox.cn/api-294072216.md): - provider > models > llm [临时测试 LLM 模型](https://ok52vhsenr.apifox.cn/api-297875365.md): - provider > models > llm [测试 LLM 模型](https://ok52vhsenr.apifox.cn/api-297877110.md): - provider > models > embedding [获取嵌入模型列表](https://ok52vhsenr.apifox.cn/api-298685819.md): - provider > models > embedding [添加嵌入模型](https://ok52vhsenr.apifox.cn/api-298685820.md): - provider > models > embedding [获取嵌入模型详细信息](https://ok52vhsenr.apifox.cn/api-298685821.md): - provider > models > embedding [删除嵌入模型](https://ok52vhsenr.apifox.cn/api-298685822.md): - provider > models > embedding [修改嵌入模型信息](https://ok52vhsenr.apifox.cn/api-298685823.md): - provider > models > embedding [临时测试嵌入模型](https://ok52vhsenr.apifox.cn/api-298685824.md): - provider > models > embedding [测试 LLM 模型](https://ok52vhsenr.apifox.cn/api-298685825.md): - provider > requesters [获取可用的请求器列表](https://ok52vhsenr.apifox.cn/api-266738936.md): - provider > requesters [获取指定请求器信息](https://ok52vhsenr.apifox.cn/api-272090461.md): - provider > requesters [请求器图标](https://ok52vhsenr.apifox.cn/api-284006294.md): - pipelines > chat [发送消息](https://ok52vhsenr.apifox.cn/api-305684617.md): - pipelines > chat [获取指定session的历史消息](https://ok52vhsenr.apifox.cn/api-305777639.md): - pipelines [获取流水线配置元数据](https://ok52vhsenr.apifox.cn/api-276165742.md): 本接口仅供参考,具体的表单模板,查看群里上次发的excalidraw图,这里的大部分配置项跟表单是对应的,可以对应判断配置项的类型。 - pipelines [获取流水线列表](https://ok52vhsenr.apifox.cn/api-276165035.md): - pipelines [新建流水线](https://ok52vhsenr.apifox.cn/api-276165916.md): 新建pipeline只需要提供name和desc; - pipelines [获取流水线信息](https://ok52vhsenr.apifox.cn/api-276166085.md): - pipelines [删除流水线](https://ok52vhsenr.apifox.cn/api-276726130.md): - pipelines [修改流水线信息](https://ok52vhsenr.apifox.cn/api-276733770.md): body跟新建一样,不允许修改 uuid, stages, for_version 字段 - platform > bots [获取机器人列表](https://ok52vhsenr.apifox.cn/api-276726856.md): - platform > bots [获取指定机器人信息](https://ok52vhsenr.apifox.cn/api-276728712.md): - platform > bots [创建机器人](https://ok52vhsenr.apifox.cn/api-276733476.md): 填写下方要求的字段,adapter_config为底层适配器所需的配置信息,需要根据所选的适配器从 获取指定适配器信息 接口中的适配器配置schema渲染表单给用户填写。 - platform > bots [删除机器人](https://ok52vhsenr.apifox.cn/api-276733499.md): - platform > bots [修改机器人配置](https://ok52vhsenr.apifox.cn/api-276734135.md): 修改的信息从body发json,不允许修改uuid,其他都可以修改;具体的结构与获取机器人信息的响应json相同。 - platform > bots [拉取机器人事件日志](https://ok52vhsenr.apifox.cn/api-296739989.md): 若要获取最末尾的十个(刚打开日志窗口时):from_index = -1, max_count = 10; - platform > adapters [获取可用的适配器列表](https://ok52vhsenr.apifox.cn/api-276728141.md): - platform > adapters [获取指定适配器信息](https://ok52vhsenr.apifox.cn/api-276728325.md): - platform > adapters [适配器图标](https://ok52vhsenr.apifox.cn/api-284010097.md): - files [下载图片文件](https://ok52vhsenr.apifox.cn/api-297186398.md): 后端自动带mimetype,这个接口的响应可以直接放到 标签 - files [上传文件](https://ok52vhsenr.apifox.cn/api-307570093.md): - knowledge > bases [获取所有知识库](https://ok52vhsenr.apifox.cn/api-304163664.md): - knowledge > bases [获取单个知识库信息](https://ok52vhsenr.apifox.cn/api-307565610.md): - knowledge > bases [创建空知识库](https://ok52vhsenr.apifox.cn/api-306087271.md): - knowledge > bases [上传并解析文件](https://ok52vhsenr.apifox.cn/api-306243922.md): - knowledge > bases [获取知识库中的文件列表](https://ok52vhsenr.apifox.cn/api-306246835.md): - knowledge > bases [删除文件](https://ok52vhsenr.apifox.cn/api-306739768.md): - knowledge > bases [删除知识库](https://ok52vhsenr.apifox.cn/api-306741113.md):