API 文档
AIFlowy 首页公司动态版本和价格产品手册开发文档API 文档
AIFlowy 首页公司动态版本和价格产品手册开发文档API 文档
Gitee
Github
  1. API 文档
  • AIFlowy 接口简介
  • 身份验证
  • 数据中枢
    • 数据中枢-数据表
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存数据表
      • 获取数据表详情
      • 删除数据表
      • 获取数据表展示表头
      • 获取数据表分页数据
      • 保存数据表数据
      • 删除数据表数据
      • 导入数据
      • 导入Excel并创建数据表
      • 获取导入模板
      • 导出数据
    • 数据源
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 测试数据库连接
      • 根据数据源ID获取表结构和字段信息
      • 更新全部数据源表结构和字段信息
      • 保存单个数据源表结构和字段信息
      • 删除数据源表结构和字段信息
    • 数据中枢-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • 数据源-数据表
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 根据数据源ID获取数据表列表
  • 数据标注
    • 数据集
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 将数据集保存到知识库
      • 导出数据集为 JSONL 格式
    • 标注任务管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存标注任务
      • 重置标注任务
      • 删除标注任务
    • 数据集QA
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 保存反馈标注的QA到数据集（同时保存问题和答案到两个表）
      • 保存标注QA
      • 审核QA
      • 批量保存分割后的QA数据
      • 分割文件并生成QA数据
    • 标注会话管理
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新会话状态
    • 数据集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 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 获取词云数据
  • 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 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • Document接口
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 更新文档
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 删除文档
      • documentList
      • 文本拆分/保存
      • 文本拆分/保存
      • 保存用户手动拆分的数据到数据库
  • 智能体
    • Bot-分类
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
    • Bot
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • 查询所有所有数据
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 生成会话ID
      • 更新Bot配置选项
      • 更新Bot模型配置
      • 语音输入转文字
      • 聊天接口
      • 更新Bot关联的模型
      • 获取Bot详情
      • 系统提示词优化
    • Bot-数据中枢
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • list
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新 Bot 数据中枢绑定
    • Bot-数据源
      • 添加（保存）数据
      • 根据主键删除数据，id 需通过 json 传入，例如：
      • 根据多个主键删数据内容，id 需通过 json 传入，例如：
      • 根据主键更新内容
      • list
      • 根据表主键查询数据详情。
      • 分页查询数据列表
      • 更新 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关系
  • 数据模型
    • Result?
    • BotCategory
    • DocumentChunkQuestion
    • WorkflowCategory
    • Dataset
    • SensitiveWord
    • Serializable
    • DocumentChunk
    • RemoveRequestDTO
    • RemoveBatchRequestDTO
    • ResultListBotCategory
    • ResultListWorkflowCategory
    • ResultListDataset
    • ResultListSensitiveWord
    • ResultBotCategory
    • ResultListDocumentChunk
    • ResultWorkflowCategory
    • ResultDataset
    • ResultSensitiveWord
    • PageBotCategory
    • ResultDocumentChunk
    • PageWorkflowCategory
    • PageDataset
    • PageSensitiveWord
    • ResultPageBotCategory
    • PageDocumentChunk
    • ResultPageWorkflowCategory
    • ResultPageDataset
    • ResultPageSensitiveWord
    • key
    • ResultPageDocumentChunk
    • ResultListWiki
    • MapObject
    • ResultListWorkflow
    • RemoveChunkRequestDTO
    • MarkTask
    • ResultListSensitiveWordPackage
    • key
    • ResultWorkflow
    • ResultListDocumentChunkQuestion
    • ResultListDatacenterTable
    • ResultListMarkTask
    • ResultSensitiveWordPackage
    • ResultWiki
    • Bot
    • PageWorkflow
    • ResultDocumentChunkQuestion
    • ResultMarkTask
    • PageSensitiveWordPackage
    • key
    • ResultPageWorkflow
    • PageDocumentChunkQuestion
    • PageMarkTask
    • ResultPageSensitiveWordPackage
    • PageWiki
    • key
    • ResultPageDocumentChunkQuestion
    • ResultDatacenterTable
    • ResultPageMarkTask
    • SensitiveWordTriggerLog
    • ResultPageWiki
    • ResultListBot
    • DocumentCollectionCategory
    • DatasetQaQuestion
    • ResultListSensitiveWordTriggerLog
    • key
    • WorkflowSingleRunDTO
    • ResultListDocumentCollectionCategory
    • DatasetQa
    • ResultSensitiveWordTriggerLog
    • key
    • ResultDocumentCollectionCategory
    • PageDatacenterTable
    • ResultListDatasetQa
    • PageSensitiveWordTriggerLog
    • ResultBot
    • WorkflowRunDTO
    • PageDocumentCollectionCategory
    • ResultPageDatacenterTable
    • ResultDatasetQa
    • ResultPageSensitiveWordTriggerLog
    • key
    • ResultPageDocumentCollectionCategory
    • PageDatasetQa
    • key
    • HeaderVo
    • ResultPageDatasetQa
    • PageBot
    • Parameter
    • ResultListHeaderVo
    • MarkMessage
    • ResultPageBot
    • MarkConversation
    • ResultLong
    • MapNodeInfo
    • Row
    • ResultListMarkConversation
    • ResultVoid
    • ChainInfo
    • ResultListDocumentCollection
    • PageRow
    • ResultMarkConversation
    • UpdateBotOptionsRequestDTO
    • ResultChainInfo
    • ResultPageRow
    • PageMarkConversation
    • WikiOptimizeDto
    • key
    • ResultDocumentCollection
    • ResultPageMarkConversation
    • UpdateBotLlmOptionsRequestDTO
    • NodeInfo
    • JSONObject
    • ResultListDatasetQaQuestion
    • ResultString
    • GetChainStatusDTO
    • PageDocumentCollection
    • ReadResVo
    • ResultDatasetQaQuestion
    • Handler
    • ResultPageDocumentCollection
    • ResultReadResVo
    • PageDatasetQaQuestion
    • MapString
    • ResultPageDatasetQaQuestion
    • MediaType
    • Document
    • WorkflowResumeDTO
    • ResultListDatacenterSource
    • SysAccount
    • DataWithMediaType
    • ResultListDocument
    • WorkflowExecResult
    • ResultDatacenterSource
    • FeedbackAnnotation
    • Throwable
    • ResultListWorkflowExecResult
    • DocumentCollectionDeptMapping
    • PageDatacenterSource
    • ResultListFeedbackAnnotation
    • StackTraceElement
    • ResultWorkflowExecResult
    • ResultListDocumentCollectionDeptMapping
    • ResultPageDatacenterSource
    • ResultFeedbackAnnotation
    • Runnable
    • PageWorkflowExecResult
    • ResultDocumentCollectionDeptMapping
    • ColumnInfo
    • PageFeedbackAnnotation
    • DefaultCallback
    • ResultPageWorkflowExecResult
    • PageDocumentCollectionDeptMapping
    • TableInfo
    • ResultPageFeedbackAnnotation
    • WikiCategory
    • ErrorCallback
    • WorkflowExecStep
    • ResultPageDocumentCollectionDeptMapping
    • ResultListTableInfo
    • ResultListWikiCategory
    • SseEmitter
    • ResultListWorkflowExecStep
    • Document
    • ResultWikiCategory
    • BotChatRequestDTO
    • JsonSchema
    • ResultWorkflowExecStep
    • ResultListDocument
    • MarkConversationMessage
    • PageWikiCategory
    • BotPromptChoreRequestDTO
    • ResultDocument
    • PageWorkflowExecStep
    • DatacenterSourceField
    • ResultPageWikiCategory
    • key
    • ToolAnnotations
    • PageDocument
    • ResultPageWorkflowExecStep
    • DatacenterSourceTable
    • ResultListMarkConversationMessage
    • key
    • ResultPageDocument
    • DatacenterTableCategory
    • Tool
    • RemoveDocRequestDTO
    • BotMessage
    • DatacenterTableField
    • ResultListDatacenterTableCategory
    • ResultMarkConversationMessage
    • Mcp
    • DocumentCollectionSplitParams
    • DatacenterTable
    • ResultDatacenterTableCategory
    • StoreManualDocuments
    • BotDatacenterTable
    • PageDatacenterTableCategory
    • PageMarkConversationMessage
    • key
    • StoreManualDocumentsRequestDTO
    • BotConversation
    • ResultPageDatacenterTableCategory
    • ResultPageMarkConversationMessage
    • key
    • ResultListDatacenterSourceTable
    • ResultListBotDatacenterTable
    • ResultDatacenterSourceTable
    • key
    • PageDatacenterSourceTable
    • key
    • ResultListMcp
    • ResultPageDatacenterSourceTable
    • ResultListBotConversation
    • ResultBotDatacenterTable
    • key
    • key
    • PageBotDatacenterTable
    • ResultPageBotDatacenterTable
    • key
    • ResultMcp
    • ResultBotConversation
    • DatacenterSource
    • BotDatasource
    • key
    • ResultListBotDatasource
    • key
    • PageBotConversation
    • PageMcp
    • ResultPageBotConversation
    • ResultBotDatasource
    • key
    • ResultPageMcp
    • GetMcpToolsRequestDTO
    • PageBotDatasource
    • ModelProvider
    • ResultPageBotDatasource
    • key
    • Model
    • ResultListModel
    • DocumentCollection
    • ResultModel
    • BotDocumentCollection
    • key
    • PageModel
    • ResultPageModel
    • ResultListBotDocumentCollection
    • key
    • key
    • key
    • ResultBotDocumentCollection
    • key
    • key
    • MapMapListModel
    • PageBotDocumentCollection
    • ResultMapMapListModel
    • key
    • ResultPageBotDocumentCollection
    • UpdateBotKnowledgeIdsRequestDTO
    • BotMcp
    • MapListModel
    • ResultListBotMcp
    • key
    • ResultMapListModel
    • ResultBotMcp
    • AddAllLlmRequestDTO
    • PageBotMcp
    • RemoveLlmRequestDTO
    • ResultPageBotMcp
    • key
    • MapListListString
    • UpdateBotMcpToolIdsRequestDTO
    • key
    • BotModel
    • ResultListBotModel
    • key
    • ResultBotModel
    • PageBotModel
    • ResultPageBotModel
    • key
    • PluginItem
    • Plugin
    • key
    • BotPlugin
    • ResultPlugin
    • ResultListBotPlugin
    • PagePlugin
    • ResultBotPlugin
    • key
    • ResultPagePlugin
    • PageBotPlugin
    • RemovePluginRequestDTO
    • ResultPageBotPlugin
    • key
    • ResultListPlugin
    • GetBotPluginListRequestDTO
    • ResultListBigInteger
    • GetBotPluginToolIdsRequestDTO
    • ResultBoolean
    • RemoveBotPluginRequestDTO
    • UpdateBotPluginToolIdsRequestDTO
    • SensitiveWordPackage
    • BotSensitiveWordPackage
    • ResultListBotSensitiveWordPackage
    • ResultListBotMessage
    • ResultBotSensitiveWordPackage
    • ResultBotMessage
    • PageBotSensitiveWordPackage
    • PageBotMessage
    • ResultPageBotSensitiveWordPackage
    • ResultPageBotMessage
    • UpdateBotSensitiveWordPackageIdsRequestDTO
    • McpStore
    • Workflow
    • ResultListMcpStore
    • BotWorkflow
    • ResultMcpStore
    • ResultListBotWorkflow
    • PageMcpStore
    • ResultBotWorkflow
    • ResultPageMcpStore
    • PageBotWorkflow
    • Resource
    • ResultPageBotWorkflow
    • ResultListResource
    • UpdateBotWorkflowIdsRequestDTO
    • ResultResource
    • TreeNode
    • key
    • PageResource
    • ResultPageResource
    • Wiki
    • BotWiki
    • key
    • ResultListBotWiki
    • key
    • ResultBotWiki
    • key
    • PageBotWiki
    • ResultPageBotWiki
    • BotRecentlyUsed
    • ResultListBotRecentlyUsed
    • ResultBotRecentlyUsed
    • PageBotRecentlyUsed
    • ResultPageBotRecentlyUsed
    • ResultListPluginItem
    • ResultPluginItem
    • PagePluginItem
    • ResultPagePluginItem
    • SearchPluginRequestDTO
    • SearchPluginToolByPluginIdRequestDTO
    • GetPluginToolListRequestDTO
    • PluginToolTestRequestDTO
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • ResultListModelProvider
    • ResultModelProvider
    • PageModelProvider
    • ResultPageModelProvider
    • PluginCategory
    • ResultListPluginCategory
    • ResultPluginCategory
    • PagePluginCategory
    • ResultPagePluginCategory
    • key
    • VectorDatabase
    • key
    • ResultListVectorDatabase
    • key
    • ResultVectorDatabase
    • key
    • PageVectorDatabase
    • ResultPageVectorDatabase
    • key
    • key
    • VerifyVectorConfigRequestDTO
    • DocumentHistory
    • ResultListDocumentHistory
    • ResultDocumentHistory
    • PageDocumentHistory
    • ResultPageDocumentHistory
    • McpStoreCategory
    • ResultListMcpStoreCategory
    • ResultMcpStoreCategory
    • PageMcpStoreCategory
    • ResultPageMcpStoreCategory
    • OcrFileParsingTask
    • ResultListOcrFileParsingTask
    • ResultOcrFileParsingTask
    • PageOcrFileParsingTask
    • ResultPageOcrFileParsingTask
    • ResourceCategory
    • ResultListResourceCategory
    • ResultResourceCategory
    • PageResourceCategory
    • ResultPageResourceCategory
    • key
    • key
    • NotificationEvent
    • key
    • key
    • ResultListNotificationEvent
    • key
    • key
    • ResultNotificationEvent
    • key
    • key
    • PageNotificationEvent
    • ResultPageNotificationEvent
    • WarningStatistic
    • ResultWarningStatistic
    • ModelTrigger
    • ResultListModelTrigger
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • key
    • NotificationRecord
    • ResultListNotificationRecord
    • ResultNotificationRecord
    • PageNotificationRecord
    • ResultPageNotificationRecord
    • key
    • key
    • key
    • key
    • PluginCategoryMapping
    • ResultListPluginCategoryMapping
    • ResultPluginCategoryMapping
    • PagePluginCategoryMapping
    • ResultPagePluginCategoryMapping
    • UpdatePluginCategoryRelationRequestDTO
  1. API 文档

身份验证

AIFlowy API 使用 API Key 进行身份验证。
您可以在 AIFlowy 控制台中创建和管理 API Key，用于访问：
智能体（Bot）
工作流（Workflow）
知识库（RAG）
MCP 服务
插件（Plugin）
模型服务
数据中枢
向量数据库
等平台能力。
请妥善保管您的 API Key。
API Key 属于敏感凭证，请不要：
在浏览器前端代码中暴露
提交到 GitHub 等代码仓库
分享给无关人员
写死在客户端应用中
生产环境建议通过：
服务端环境变量
Secret Manager
KMS 密钥管理服务
等方式安全管理 API Key。

HTTP 请求头#

所有 API 请求都需要在 HTTP Header 中携带 API Key：
例如：

API Key 示例#

cURL#

Python 示例#

Node.js 示例#

多租户请求#

对于拥有多个组织（Organization）或多个项目（Project）的用户，可以通过请求头指定当前请求所属的组织。
请求头示例：
例如：
对应请求产生的：
Token 消耗
调用统计
日志记录
配额限制
都将归属于指定组织。

项目级请求#

AIFlowy 同时支持 Project 级别隔离。
您可以通过 Header 指定当前项目：
例如：

安全建议#

不要在前端暴露 API Key#

错误示例：
API Key 一旦泄露，任何人都可以调用您的 AIFlowy 服务。

使用服务端代理#

推荐架构：
Browser/App
    ↓
Your Backend Server
    ↓
AIFlowy API
由后端统一管理 API Key。

使用环境变量#

推荐使用：
避免将 Key 写入代码仓库。

定期轮换 API Key#

建议定期更新 API Key，降低泄露风险。
例如：
开发环境
测试环境
生产环境
分别使用不同的 Key。

常见错误#

401 Unauthorized#

表示：
API Key 不存在
API Key 无效
API Key 已过期
示例响应：
{
  "code": 401,
  "message": "Invalid API Key"
}

403 Forbidden#

表示当前 API Key 没有对应资源权限。
例如：
无法访问某个 Bot
无法调用 Workflow
无法访问知识库
示例响应：
{
  "code": 403,
  "message": "Permission denied"
}

429 Too Many Requests#

表示当前请求频率超过限制。
AIFlowy 会根据：
用户等级
租户配额
模型资源
系统负载
进行限流控制。
示例响应：
{
  "code": 429,
  "message": "Rate limit exceeded"
}

下一步#

完成身份验证后，您可以继续阅读以下内容：
Bot API
Workflow API
RAG API
MCP API
Plugin API
模型管理 API
数据中枢 API
开始构建属于您的企业级 AI 应用。
修改于 2026-05-13 02:46:40
上一页
AIFlowy 接口简介
下一页
添加（保存）数据
Built with