首页公司动态版本和价格产品手册开发文档API 文档
首页公司动态版本和价格产品手册开发文档API 文档
Gitee 开源地址
Github 开源地址
  1. API 文档
  • AIFlowy 接口简介
  • 身份验证
  • AIFlowy Chat Protocol Specification v1.1
  • 第三方登录
    • 第三方登录(基于AIFlowy后台访问令牌授权登录)
      • 登录
      • 退出登录（通过 token 验证并注销用户）
    • 第三方系统用户绑定账号 (基于Oauth2绑定第三方用户openId)
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 智能体
    • Bot
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 生成会话ID
      • 更新Bot配置选项
      • 更新Bot模型配置
      • 语音输入转文字
      • 聊天接口
      • 更新Bot关联的模型
      • 获取Bot详情
      • 系统提示词优化
    • Bot-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • Bot-数据中枢
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • list
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新 Bot 数据中枢绑定
    • Bot-数据源
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • list
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新 Bot 数据源绑定
    • Bot-知识库
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 获取知识库列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新Bot知识库ID列表
    • Bot-MCP
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新 Bot Mcp 工具配置
    • Bot-大模型
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • Bot-插件
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 获取Bot插件列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取Bot插件列表
      • 获取Bot插件工具ID列表
      • 移除Bot插件
      • 更新Bot插件工具ID列表
    • Bot-敏感词
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 获取敏感词包列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新Bot敏感词包ID列表
    • Bot-工作流
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 获取工作流列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新Bot工作流ID列表
    • Bot-Wiki
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新Bot-Wiki关系
  • 工作流
    • 工作流-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 工作流
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 节点单独运行
      • 运行工作流 - v2
      • 获取工作流运行状态 - v2
      • 恢复工作流运行 - v2
      • 导入工作流
      • 导出工作流
      • 获取运行时参数
      • 复制工作流
    • 工作流执行记录
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • del
    • 执行记录步骤
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • getListByRecordId
    • 工作流节点
      • getChainParams
  • 知识库
    • 文档分块
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 更新文档块
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 移除文档块
    • 文档分块问题
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 知识库分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 知识库
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 知识库搜索
    • 知识库-部门权限
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 知识库文档
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 更新文档
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 删除文档
      • documentList
      • 文本拆分/保存
      • 文本拆分/保存
      • 保存用户手动拆分的数据到数据库
    • OCR文件解析任务
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • Wiki 知识树
    • Wiki知识树
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 提取前言
      • 根据子内容优化标题或描述
      • 批量保存前言
    • Wiki知识树-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • Wiki知识树-前言
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 素材库
    • 素材库分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 素材库
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 数据中枢
    • 数据中枢-数据表
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存数据表
      • 获取数据表详情
      • 删除数据表
      • 获取数据表展示表头
      • 获取数据表分页数据
      • 保存数据表数据
      • 删除数据表数据
      • 导入数据
      • 导入Excel并创建数据表
      • 获取导入模板
      • 导出数据
    • 数据中枢-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 数据源
    • 数据源
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 测试数据库连接
      • 根据数据源ID获取表结构和字段信息
      • 更新全部数据源表结构和字段信息
      • 保存单个数据源表结构和字段信息
      • 删除数据源表结构和字段信息
    • 数据源-数据表
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 根据数据源ID获取数据表列表
  • 模型管理
    • 模型
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 获取模型列表
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取模型列表
      • 添加AI模型
      • 验证模型配置
      • 根据实体移除模型
      • 根据实体更新模型
      • 根据供应商分类选择模型
      • 根据供应商和模型类型选择模型
      • 添加列表中的所有模型
      • 选择模型列表
      • 根据ID移除模型
    • 模型-提供商
      • 添加（保存）数据
      • 删除模型提供商
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 插件
    • 插件-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • doRemoveCategory
    • 插件-分类映射接口（一对多）
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新插件分类关系
      • getPluginCategories
    • 插件接口
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存插件
      • 更新插件
      • 移除插件
      • 获取插件列表
      • 根据分类分页获取插件列表
    • 插件-工具
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存插件工具
      • 搜索插件工具
      • 根据插件ID搜索插件工具列表
      • 更新插件工具
      • 获取插件工具列表
      • 获取TinyFlow数据
      • 插件试运行接口
  • MCP
    • Mcp
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取MCP工具
      • pageTools
    • MCP商店-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • MCP商店
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • detail
      • list
      • install
  • 向量数据库
    • 向量数据库
      • 保存向量库配置
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 验证向量配置
  • 数据标注
    • 数据集
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 将数据集保存到知识库
      • 导出数据集为 JSONL 格式
    • 数据集QA
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存反馈标注的QA到数据集（同时保存问题和答案到两个表）
      • 保存标注QA
      • 审核QA
      • 批量保存分割后的QA数据
      • 分割文件并生成QA数据
    • 数据集QA问题管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 反馈标注管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询
      • 提交消息反馈（点赞/点踩）
    • 标注会话管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新会话状态
    • 标注会话消息管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 标注任务管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存标注任务
      • 重置标注任务
      • 删除标注任务
  • 敏感词
    • 敏感词
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 敏感词包
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 敏感词触发日志
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取词云数据
  • 预警管理
    • 通知事件
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 更新通知事件
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取预警统计信息
      • 获取模型调用token量图表数据
      • 用户用量排行
    • 通知事件记录
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
  • 用户管理
    • 用户管理。
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
    • 获取当前用户信息
    • 修改用户信息, 用于修改用户自己的信息包括昵称，手机，邮箱，头像
    • 修改密码，用于修改用户自己的密码
  • 部门管理
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • list
    • 根据表主键查询数据详情。
    • 分页查询数据列表
    • importExcel
    • getTemplate
  • 岗位管理
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询岗位列表
    • 修改岗位状态（启用/禁用）
  • 角色管理
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
    • 保存角色菜单
    • 获取角色菜单id
    • 获取角色部门id
    • 保存角色
  • 租户管理
    • 保存租户
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 更新租户
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
  • 租户套餐
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
  • 定时任务
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
    • 启动定时任务
    • 停止定时任务
    • 获取定时任务的下一个执行时间
  • 菜单管理
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 获取菜单列表
    • 根据表主键查询数据详情。
    • 分页查询数据列表
    • 根据账号id获取菜单树
    • 获取菜单树
    • 获取菜单树V2
    • 根据角色id获取菜单树
  • 日志管理
    • 添加（保存）数据
    • 根据主键删除数据，id 需通过 json 传入，例如：
    • 根据多个主键删数据内容，id 需通过 json 传入，例如：
    • 根据主键更新内容
    • 查询所有所有数据
    • 根据表主键查询数据详情。
    • 分页查询数据列表
  • 数据模型
    • Result?
    • key
    • BotCategory
    • DocumentChunkQuestion
    • PluginCategory
    • OcrFileParsingTask
    • ResourceCategory
    • WorkflowCategory
    • Dataset
    • SensitiveWord
    • TreeNode
    • WikiCategory
    • SysPosition
    • SysRole
    • SysTenant
    • SysTenantPackage
    • ThirdPartyLoginRequest
    • MapObject
    • DocumentChunk
    • SysDept
    • SysLog
    • SysMenu
    • ThirdPartyLogoutRequest
    • ModelProvider
    • DatacenterSource
    • SysAccount
    • SysAccountOpenid
    • Serializable
    • Model
    • VectorDatabase
    • NotificationEvent
    • Wiki
    • SysJob
    • RemoveRequestDTO
    • JsonSchema
    • ResultListBotCategory
    • ResultListPluginCategory
    • ResultListOcrFileParsingTask
    • ResultListResourceCategory
    • ResultListWorkflowCategory
    • ResultListDataset
    • ResultListSensitiveWord
    • ResultListWikiCategory
    • ResultListSysPosition
    • ResultListSysRole
    • ResultListSysTenantPackage
    • RemoveBatchRequestDTO
    • ResultBotCategory
    • ResultListDocumentChunk
    • ResultPluginCategory
    • ResultOcrFileParsingTask
    • ResultResourceCategory
    • ResultWorkflowCategory
    • ResultDataset
    • ResultSensitiveWord
    • ResultWikiCategory
    • ResultListSysDept
    • ResultSysPosition
    • ResultSysRole
    • ResultListSysTenant
    • ResultSysTenantPackage
    • ResultListSysLog
    • ResultListSysMenu
    • key
    • ToolAnnotations
    • PageBotCategory
    • ResultDocumentChunk
    • PagePluginCategory
    • PageOcrFileParsingTask
    • PageResourceCategory
    • PageWorkflowCategory
    • PageDataset
    • PageSensitiveWord
    • PageWikiCategory
    • ResultSysDept
    • PageSysPosition
    • PageSysRole
    • ResultSysTenant
    • PageSysTenantPackage
    • ResultSysLog
    • ResultSysMenu
    • ResultPageBotCategory
    • PageDocumentChunk
    • ResultPagePluginCategory
    • ResultPageOcrFileParsingTask
    • ResultPageResourceCategory
    • ResultPageWorkflowCategory
    • ResultListDatacenterSource
    • ResultPageDataset
    • ResultPageSensitiveWord
    • ResultPageWikiCategory
    • ResultListSysAccount
    • PageSysDept
    • ResultPageSysPosition
    • ResultPageSysRole
    • PageSysTenant
    • ResultPageSysTenantPackage
    • PageSysLog
    • PageSysMenu
    • ResultListSysAccountOpenid
    • key
    • Tool
    • ResultListModel
    • ResultBoolean
    • ResultPageDocumentChunk
    • SensitiveWordPackage
    • ResultListWiki
    • ResultPageSysDept
    • ResultPageSysTenant
    • ResultPageSysLog
    • ResultPageSysMenu
    • Mcp
    • ResultListWorkflow
    • RemoveChunkRequestDTO
    • ResultListVectorDatabase
    • ResultListNotificationEvent
    • PluginCategoryMapping
    • ResultDatacenterSource
    • DatasetQaQuestion
    • ResultListSensitiveWordPackage
    • ResultWikiFrontMatter
    • ResultSysAccount
    • SysDeptExcel
    • ResultListSysJob
    • MetaVo
    • ResultSysAccountOpenid
    • key
    • key
    • ResultModel
    • Resource
    • ResultWorkflow
    • ResultListDocumentChunkQuestion
    • ResultListPluginCategoryMapping
    • ResultListDatacenterTable
    • DatasetQa
    • ResultSensitiveWordPackage
    • ResultWiki
    • ReadExcelResultSysDeptExcel
    • MenuVo
    • Bot
    • key
    • PageWorkflow
    • ResultDocumentChunkQuestion
    • ResultPluginCategoryMapping
    • PageDatacenterSource
    • ResultListDatasetQa
    • PageSensitiveWordPackage
    • PageWikiFrontMatter
    • PageSysAccount
    • ResultReadExcelResultSysDeptExcel
    • ResultListMenuVo
    • PageSysAccountOpenid
    • PageModel
    • ResultListResource
    • ResultPageWorkflow
    • ResultListBigInteger
    • ResultVectorDatabase
    • ResultNotificationEvent
    • PageDocumentChunkQuestion
    • PagePluginCategoryMapping
    • ResultPageDatacenterSource
    • ResultDatasetQa
    • ResultPageSensitiveWordPackage
    • PageWiki
    • ResultPageWikiFrontMatter
    • ResultPageSysAccount
    • ResultSysJob
    • ResultPageSysAccountOpenid
    • key
    • ResultVoid
    • ResultPageModel
    • ResultPageDocumentChunkQuestion
    • ResultPagePluginCategoryMapping
    • ResultDatacenterTable
    • PageDatasetQa
    • SensitiveWordTriggerLog
    • ResultPageWiki
    • ResultListBot
    • key
    • ResultResource
    • UpdatePluginCategoryRelationRequestDTO
    • DocumentCollectionCategory
    • ColumnInfo
    • ResultPageDatasetQa
    • ResultListSensitiveWordTriggerLog
    • WikiFrontMatter
    • UpdatePasswordDTO
    • PluginItem
    • WorkflowSingleRunDTO
    • PageVectorDatabase
    • PageNotificationEvent
    • ResultListDocumentCollectionCategory
    • TableInfo
    • MarkMessage
    • ResultSensitiveWordTriggerLog
    • ResultListWikiFrontMatter
    • PageSysJob
    • Plugin
    • PageResource
    • ResultPageVectorDatabase
    • ResultPageNotificationEvent
    • ResultDocumentCollectionCategory
    • PageDatacenterTable
    • ResultListTableInfo
    • ResultListDatasetQaQuestion
    • PageSensitiveWordTriggerLog
    • ResultPageSysJob
    • ResultBot
    • key
    • MapMapListModel
    • ResultListPlugin
    • ResultPageResource
    • WorkflowRunDTO
    • WarningStatistic
    • PageDocumentCollectionCategory
    • ResultPageDatacenterTable
    • ResultDatasetQaQuestion
    • ResultPageSensitiveWordTriggerLog
    • key
    • ResultListMcp
    • ResultMapMapListModel
    • ResultPlugin
    • ResultWarningStatistic
    • ResultPageDocumentCollectionCategory
    • PageDatasetQaQuestion
    • SaveFrontMatterDTO
    • ResultListString
    • Handler
    • key
    • PagePlugin
    • VerifyVectorConfigRequestDTO
    • ModelTrigger
    • HeaderVo
    • DatacenterSourceField
    • ResultPageDatasetQaQuestion
    • PageBot
    • MapString
    • key
    • ResultPagePlugin
    • Parameter
    • ResultListModelTrigger
    • ResultListHeaderVo
    • DatacenterSourceTable
    • ResultPageBot
    • MediaType
    • key
    • MapListModel
    • RemovePluginRequestDTO
    • NotificationRecord
    • FeedbackAnnotation
    • AccountUsageVo
    • DataWithMediaType
    • key
    • ResultMapListModel
    • MapNodeInfo
    • ResultListPluginItem
    • ResultListNotificationRecord
    • Row
    • ResultListFeedbackAnnotation
    • ResultListAccountUsageVo
    • Throwable
    • key
    • AddAllLlmRequestDTO
    • ChainInfo
    • ResultPluginItem
    • ResultListDocumentCollection
    • ResultNotificationRecord
    • PageRow
    • ResultListDatacenterSourceTable
    • ResultFeedbackAnnotation
    • UpdateBotOptionsRequestDTO
    • StackTraceElement
    • ResultMcp
    • RemoveLlmRequestDTO
    • ResultChainInfo
    • PagePluginItem
    • PageNotificationRecord
    • ResultPageRow
    • PageFeedbackAnnotation
    • Runnable
    • key
    • ResultPagePluginItem
    • ResultListModelProvider
    • ResultDocumentCollection
    • ResultPageNotificationRecord
    • ResultDatacenterSourceTable
    • ResultPageFeedbackAnnotation
    • UpdateBotLlmOptionsRequestDTO
    • DefaultCallback
    • key
    • NodeInfo
    • SearchPluginRequestDTO
    • ResultModelProvider
    • JSONObject
    • MarkConversation
    • ResultString
    • ErrorCallback
    • key
    • GetChainStatusDTO
    • SearchPluginToolByPluginIdRequestDTO
    • PageModelProvider
    • PageDocumentCollection
    • ReadResVo
    • PageDatacenterSourceTable
    • ResultListMarkConversation
    • SseEmitter
    • key
    • GetPluginToolListRequestDTO
    • ResultPageModelProvider
    • ResultPageDocumentCollection
    • ResultReadResVo
    • ResultPageDatacenterSourceTable
    • ResultMarkConversation
    • key
    • PluginToolTestRequestDTO
    • PageMarkConversation
    • WikiOptimizeDto
    • PageMcp
    • Document
    • WorkflowResumeDTO
    • ResultPageMarkConversation
    • ResultPageMcp
    • ResultListDocument
    • WorkflowExecResult
    • GetMcpToolsRequestDTO
    • ResultListWorkflowExecResult
    • DocumentCollectionDeptMapping
    • McpStoreCategory
    • ResultWorkflowExecResult
    • ResultListDocumentCollectionDeptMapping
    • MarkConversationMessage
    • ResultListMcpStoreCategory
    • PageWorkflowExecResult
    • ResultDocumentCollectionDeptMapping
    • ResultMcpStoreCategory
    • ResultPageWorkflowExecResult
    • PageDocumentCollectionDeptMapping
    • ResultListMarkConversationMessage
    • PageMcpStoreCategory
    • WorkflowExecStep
    • ResultPageDocumentCollectionDeptMapping
    • ResultPageMcpStoreCategory
    • ResultListWorkflowExecStep
    • Document
    • ResultMarkConversationMessage
    • BotChatRequestDTO
    • key
    • ResultWorkflowExecStep
    • ResultListDocument
    • BotPromptChoreRequestDTO
    • ResultDocument
    • McpStore
    • PageWorkflowExecStep
    • PageMarkConversationMessage
    • key
    • PageDocument
    • ResultPageWorkflowExecStep
    • ResultPageMarkConversationMessage
    • ResultPageDocument
    • ResultListMcpStore
    • DatacenterTableCategory
    • MarkTask
    • key
    • RemoveDocRequestDTO
    • BotMessage
    • DatacenterTableField
    • ResultListDatacenterTableCategory
    • ResultListMarkTask
    • DocumentCollectionSplitParams
    • ResultMcpStore
    • DatacenterTable
    • ResultDatacenterTableCategory
    • ResultMarkTask
    • key
    • StoreManualDocuments
    • BotDatacenterTable
    • PageDatacenterTableCategory
    • PageMarkTask
    • StoreManualDocumentsRequestDTO
    • PageMcpStore
    • BotConversation
    • ResultPageDatacenterTableCategory
    • ResultPageMarkTask
    • ResultPageMcpStore
    • ResultLong
    • ResultListBotDatacenterTable
    • ResultListBotConversation
    • ResultBotDatacenterTable
    • PageBotDatacenterTable
    • ResultPageBotDatacenterTable
    • ResultBotConversation
    • BotDatasource
    • ResultListBotDatasource
    • PageBotConversation
    • ResultPageBotConversation
    • ResultBotDatasource
    • PageBotDatasource
    • ResultPageBotDatasource
    • DocumentCollection
    • BotDocumentCollection
    • ResultListBotDocumentCollection
    • key
    • key
    • ResultBotDocumentCollection
    • key
    • key
    • PageBotDocumentCollection
    • key
    • ResultPageBotDocumentCollection
    • UpdateBotKnowledgeIdsRequestDTO
    • BotMcp
    • ResultListBotMcp
    • key
    • ResultBotMcp
    • PageBotMcp
    • ResultPageBotMcp
    • key
    • MapListListString
    • UpdateBotMcpToolIdsRequestDTO
    • key
    • BotModel
    • ResultListBotModel
    • key
    • ResultBotModel
    • PageBotModel
    • ResultPageBotModel
    • key
    • key
    • BotPlugin
    • ResultListBotPlugin
    • ResultBotPlugin
    • key
    • PageBotPlugin
    • ResultPageBotPlugin
    • key
    • GetBotPluginListRequestDTO
    • GetBotPluginToolIdsRequestDTO
    • RemoveBotPluginRequestDTO
    • UpdateBotPluginToolIdsRequestDTO
    • BotSensitiveWordPackage
    • ResultListBotSensitiveWordPackage
    • ResultListBotMessage
    • ResultBotSensitiveWordPackage
    • ResultBotMessage
    • PageBotSensitiveWordPackage
    • PageBotMessage
    • ResultPageBotSensitiveWordPackage
    • ResultPageBotMessage
    • UpdateBotSensitiveWordPackageIdsRequestDTO
    • Workflow
    • BotWorkflow
    • ResultListBotWorkflow
    • ResultBotWorkflow
    • PageBotWorkflow
    • ResultPageBotWorkflow
    • UpdateBotWorkflowIdsRequestDTO
    • key
    • BotWiki
    • key
    • ResultListBotWiki
    • key
    • ResultBotWiki
    • key
    • PageBotWiki
    • ResultPageBotWiki
    • BotRecentlyUsed
    • ResultListBotRecentlyUsed
    • ResultBotRecentlyUsed
    • PageBotRecentlyUsed
    • ResultPageBotRecentlyUsed
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • DocumentHistory
    • ResultListDocumentHistory
    • ResultDocumentHistory
    • PageDocumentHistory
    • ResultPageDocumentHistory
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
  1. API 文档

AIFlowy 接口简介

1. 背景与愿景#

随着 AI 技术进入深水区，企业对智能体的应用正在从“体验式对话”阶段，逐步走向以业务流程为核心的“工程化落地”。
企业不再满足于基于聊天窗口的交互方式，而是希望像调用数据库、微服务或消息队列一样，以稳定、可控、可集成的方式，将 AI 能力嵌入到现有系统中。
在这一背景下，AIFlowy API 应运而生，通过 AIFlowy API，企业获得的不只是接口本身，而是一套面向生产环境的 AI 能力运行与调度体系（AI Runtime）。
它支持以代码驱动的方式，对智能体的感知、推理与执行能力进行统一编排，从而将 AI 真正转化为业务系统中的基础能力组件。

2. AIFlowy API 核心架构概览#

AIFlowy API 采用 RESTful 风格，基于 HTTPS 协议，通过 API Key 进行身份认证。整体架构分为五大层级：
1.
交互层 (Interaction Layer)：智能体 (Bot)、工作流 (Workflow)。
2.
知识层 (Knowledge Layer)：知识库 RAG、Wiki 知识树、素材库。
3.
数据层 (Data Layer)：数据中枢、向量数据库、数据集。
4.
扩展层 (Extension Layer)：插件 (Plugins)、MCP (Model Context Protocol)。
5.
治理层 (Governance Layer)：模型管理、安全合规、日志分析、反馈闭环。

3. 详细模块详解#

3.1 智能体与工作流引擎#

这是 AIFlowy 的核心执行单元，负责处理复杂的逻辑推理和任务执行。

智能体 API#

智能体是拥有特定人设、记忆和工具使用权的 AI 实体。
核心能力：
多轮对话上下文管理：自动维护会话状态，支持长短期记忆切换。
动态工具调用：根据用户意图，自动选择并调用绑定的插件或 MCP 服务。
RAG 增强：自动检索相关知识库，生成基于事实的回答。
典型接口：
POST /public-api/v1/bot/chat：发起流式对话。
GET /public-api/v1/bot/botConversation/page：获取指定会话的历史记录和上下文摘要。
应用场景：
嵌入企业官网的 7x24 小时智能客服。
集成在 CRM 中的 销售助手，自动分析客户画像并推荐话术。

工作流 API#

工作流是将复杂任务拆解为多个步骤（节点）并串联执行的引擎。相比单一 Bot，Workflow 更适合确定性高、流程长的业务场景。
核心能力：
可视化编排执行：支持串行、并行、条件分支、循环等复杂逻辑。
变量传递：节点间通过上下文变量传递数据。
人工介入节点：支持在流程中暂停，等待人工审核或输入。
典型接口：
POST /public-api/v1/workflow/runAsync：触发工作流执行，传入初始参数（JSON）。
GET /public-api/v1/workflow/getChainStatus：查询长耗时任务的执行状态。
POST /public-api/v1/workflow/resume：在人工审核节点后，提交审核结果以恢复流程。
应用场景：
自动化研报生成：抓取新闻 -> 总结要点 -> 生成图表 -> 撰写报告 -> 发送邮件。
智能合同审核：OCR 识别合同 -> 提取关键条款 -> 比对合规库 -> 生成风险报告。

3.2 知识管理与 RAG 引擎#

让 AI 懂业务、懂内部数据的关键。AIFlowy 提供了两种形态的知识管理：非结构化文档 RAG 和 结构化 Wiki 知识树。

知识库 RAG API#

核心能力：
多格式解析：支持 PDF, Word, Excel, PPT, Markdown, TXT 等格式的高精度解析。
智能分块 (Chunking)：基于语义而非固定字符数的智能切片，保留上下文完整性。
混合检索 (Hybrid Search)：结合关键词检索 (BM25) 和向量检索 (Vector)，提高召回率。
重排 (Rerank)：使用专用重排模型对召回片段进行相关性排序，提升最终回答质量。
典型接口：
POST /public-api/v1/documentCollection/save：上传文档并触发异步解析索引。
GET /public-api/v1/documentCollection/search：执行语义检索，返回相关片段及相似度得分。
POST /public-api/v1/documentCollection/remove：删除文档并清理向量索引。
应用场景：
企业内部知识问答：员工询问“报销流程”，AI 基于最新制度文档回答。
技术支持助手：基于产品手册和故障案例库，辅助技术人员排查问题。

Wiki 知识树 API#

传统 RAG 适合碎片化知识，而 Wiki 知识树 适合结构化、层级化的知识体系。
核心优势：
结构化存储：知识以树状节点存在，每个节点包含标题、内容、关联标签。
关系感知：AI 理解知识的上下级关系（如：产品 -> 模块 -> 功能 -> 参数）。
长期记忆载体：适合作为 AI 的“长期记忆库”，存储经过验证的高质量知识。
典型接口：
POST /public-api/v1/wiki/save：创建/更新知识节点。
GET /public-api/v1/wiki/list?asTree=true：获取节点的完整路径，用于构建面包屑导航或上下文注入。
应用场景：
产品文档中心：构建可交互的产品说明书，AI 可沿树状结构深入讲解。
行业专家系统：将行业标准、法规以树状结构沉淀，确保 AI 回答的逻辑严密性。

3.3 数据智能与向量底座#

数据中枢 API#

让非技术人员也能通过自然语言查询数据库。
核心能力：
Text-to-SQL：基于 Schema 信息，将自然语言转换为可执行 SQL。
多数据源支持：MySQL, PostgreSQL, Oracle, ClickHouse, Elasticsearch 等。
安全沙箱：只读权限控制，防止误删改；敏感字段自动脱敏。
图表推荐：根据数据类型自动推荐合适的可视化图表（折线图、柱状图等）。
应用场景：
BI 自助分析：运营人员问“上周各地区的销售额对比”，直接生成报表。
实时监控大屏：通过 API 定时查询关键指标，驱动前端大屏更新。

3.4 扩展生态：插件与 MCP#

打破 AI 的信息孤岛，连接外部世界。

插件 API#

核心能力：
自定义鉴权：支持 API Key, OAuth2, Basic Auth 等多种鉴权方式。
参数映射：灵活配置 LLM 输出到插件输入参数的映射规则。
典型接口：
POST /public-api/v1/pluginItem/test：手动触发插件执行，用于测试或特定业务逻辑。
GET /public-api/v1/pluginItem/tool/list：获取可用插件列表及描述。
应用场景：
天气查询：AI 调用天气插件回答“明天北京天气如何”。
Jira/钉钉集成：AI 自动创建任务票或发送通知消息。

MCP API#

AIFlowy 是 MCP 协议的坚定支持者，旨在实现 AI 与本地/远程工具的标准化互联。
核心能力：
MCP Server 管理：注册、发现、监控 MCP 服务器状态。
工具动态加载：运行时动态加载 MCP 提供的 Tools, Resources, Prompts。
MCP 商店集成：一键安装社区发布的 MCP 服务。
典型接口：
POST /public-api/v1/mcp/save：注册一个新的 MCP Server。
GET /public-api/v1/mcp/getMcpTools：列出所有已连接的 MCP 工具及其 Schema。
应用场景：
IDE 集成：通过 MCP 连接本地文件系统，让 AI 辅助编写代码。
浏览器自动化：连接 Browser MCP，让 AI 能够浏览网页、提取信息。

3.5 模型管理与基础设施#

模型管理 API#

核心能力：
多模型路由：根据任务类型（聊天、编码、数学）自动路由到最佳模型。
负载均衡与降级：当主模型超时或错误时，自动切换到备用模型。
统一计费与配额：统计各模型的 Token 消耗，支持租户级配额限制。
支持模型类型：
Chat Models (Qwen, DeepSeek, Claude, GPT-4o...)
Embedding Models (BGE, M3E...)
Rerank Models (BGE-Reranker...)
OCR Models (PaddleOCR, Tesseract...)
典型接口：
GET /public-api/v1/model/verifyLlmConfig：检查各模型提供商的健康状态。

3.6 数据闭环与安全治理#

企业级应用的核心壁垒：安全与进化。

安全与合规 API#

敏感词库：
SensitiveWordService -> containSensitiveWord：预检文本，识别政治、暴力、色情等敏感内容。
支持自定义词库导入，满足行业合规要求（如金融、医疗）。
预警管理：
实时监控 API 调用异常、Token 消耗激增、潜在的攻击行为（Prompt Injection）。
支持 Webhook 回调告警。

对话分析与反馈闭环#

用户反馈 (Feedback)：
POST /public-api/v1/feedbackAnnotation/submit：提交点赞/点踩及原因。
自动化标注：点踩数据自动进入“待标注队列”，结合人工修正，形成高质量 SFT 数据集。
深度洞察 (Insights)：
GET /public-api/v1/bot/userProfile/{conversationId}/analyze：获取单次对话的深度分析报告，包括：
用户核心诉求：AI 提炼的用户真实意图。
用户画像推测：基于对话内容推测的职业、兴趣、专业程度。
情感分析：用户情绪变化曲线。
价值：帮助产品经理优化 Bot 人设，帮助销售人员洞察客户潜在需求。

4. 接入指南与技术规范#

4.1 认证机制#

所有 API 请求必须在 Header 中包含 API Key：
安全性：API Key 具有权限 scope ，后台可自由分配可访问的权限接口。

4.2 响应格式#

统一 JSON 响应结构：
{
  "errorCode": 0,
  "message": "成功",
  "data": { ... }
}
错误处理：非 0 状态码时，message 包含错误详情，errorCode 为具体错误码（如 401 代表 Key 无效）。

5. 典型集成案例#

案例一：Java 后端集成智能客服#

使用 SpringBoot + RestTemplate/OkHttp 调用 AIFlowy Bot API。

案例二：自动化周报生成工作流#

1.
触发：每周五下午 5 点，cron 任务调用 POST /public-api/v1/workflow/runAsync。
2.
输入：
{
    "id": "1",
    "variables": {
        "weekStart": "2026-05-04",
        "weekEnd": "2026-05-08"
    }
}
3.
执行：
节点1：调用 Jira Plugin 获取本周完成的任务。
节点2：调用 Git Plugin 获取代码提交记录。
节点3：LLM 节点汇总信息，生成周报草稿。
节点4：人工审核节点（暂停）。
节点5：邮件 Plugin 发送最终周报。
4.
结果：员工只需在收到审核通知时确认即可，大幅减少重复劳动。

6. 结语：共建 AI 生态#

AIFlowy API 的推出，是我们推动 AI 生态标准化 的重要一步。我们希望通过开放、稳定、高效的接口，降低企业使用 AI 的门槛，让每一位 Java 开发者都能轻松构建出具备“感知、思考、行动”能力的智能应用。
未来，我们将持续迭代：
更深度的 MCP 生态集成。
更强大的 多模态处理能力（视频、音频）。
更完善的 私有化部署方案。
欢迎加入 AIFlowy 开发者社区，一起探索 AI 原生应用的无限可能。
修改于 2026-05-17 01:42:49
下一页
身份验证
Built with