# Dify Docs: Chinese 自部署 开发者资源 API > Dify is an open-source platform for building AI applications. It provides a comprehensive set of tools and features to help you build, deploy, and manage your AI applications. ## API ### 指南 - [Dify API 快速开始](https://docs.dify.ai/zh/api-reference/guides/get-started.md): 获取 API 密钥、发起第一个请求,并找到你的应用类型对应的接口 - [处理流式响应](https://docs.dify.ai/zh/api-reference/guides/streaming.md): 选择响应模式、解析 SSE 流、按事件类型分发处理,并在连接断开后恢复 - [人工介入 API 集成流程](https://docs.dify.ai/zh/api-reference/guides/human-input-flow.md): 通过 API 处理暂停中的人工介入表单的端到端流程 - [终端用户身份](https://docs.dify.ai/zh/api-reference/guides/end-user-identity.md): user 字段标识什么、限定哪些数据,以及为何要在各次调用间保持一致 - [处理错误与速率限制](https://docs.dify.ai/zh/api-reference/guides/errors.md): 错误响应的统一结构、各状态码类别的含义,以及哪些失败值得重试 #### API 概览 - [Chatflow 应用 API](https://docs.dify.ai/zh/api-reference/guides/chatflow.md): Chatflow 应用 API,涵盖对话消息、工作流级别流式事件、会话管理、人工介入暂停 - [Workflow 应用 API](https://docs.dify.ai/zh/api-reference/guides/workflow.md): Workflow 应用 API,涵盖工作流执行、运行控制与流式传输、人工介入暂停、运行历史查询 - [Agent API](https://docs.dify.ai/zh/api-reference/guides/agent.md): 面向 Agent 应用的 API,涵盖流式对话消息、会话管理、文件上传及应用配置 - [对话型应用 API](https://docs.dify.ai/zh/api-reference/guides/chat.md): 面向聊天助手和旧版 Agent 应用的 API,涵盖对话消息、会话管理、文件上传、语音转换及标注管理 - [文本生成应用 API](https://docs.dify.ai/zh/api-reference/guides/completion.md): 面向文本生成应用的 API,涵盖文本生成消息、文件上传、语音转换及反馈收集 ##### 知识库 - [知识库 API](https://docs.dify.ai/zh/api-reference/guides/knowledge-base-api.md): 创建两种知识库 API 通用的 API 密钥并设置访问范围,安全地替换密钥,以及查明调用被拒绝的原因 - [Agent 知识库 API](https://docs.dify.ai/zh/api-reference/guides/knowledge-base.md): 在自己的代码中查询 Agent 知识库,回查某次运行检索到的内容,并维护知识库的文档、数据源和设置 - [经典知识库 API](https://docs.dify.ai/zh/api-reference/guides/knowledge.md): 用于管理经典知识库、文档、分段、元数据、标签和知识流水线的 API ### 应用 API #### 对话消息 - [发送对话消息](https://docs.dify.ai/zh/api-reference/chat-messages/send-chat-message.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 - [停止对话消息生成](https://docs.dify.ai/zh/api-reference/chat-messages/stop-chat-message-generation.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 - [获取下一轮建议问题列表](https://docs.dify.ai/zh/api-reference/chat-messages/get-next-suggested-questions.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 #### 文本生成消息 - [发送消息](https://docs.dify.ai/zh/api-reference/completion-messages/send-completion-message.md): **适用于**:文本生成应用。 - [停止消息生成](https://docs.dify.ai/zh/api-reference/completion-messages/stop-completion-message-generation.md): **适用于**:文本生成应用。 #### 工作流运行 - [执行工作流](https://docs.dify.ai/zh/api-reference/workflow-runs/run-workflow.md): **适用于**:Workflow。 - [按 ID 执行工作流](https://docs.dify.ai/zh/api-reference/workflow-runs/run-workflow-by-id.md): **适用于**:Workflow。 - [停止工作流任务](https://docs.dify.ai/zh/api-reference/workflow-runs/stop-workflow-task.md): **适用于**:Workflow。 - [获取工作流执行情况](https://docs.dify.ai/zh/api-reference/workflow-runs/get-workflow-run-detail.md): **适用于**:Chatflow、Workflow。 - [获取工作流日志](https://docs.dify.ai/zh/api-reference/workflow-runs/list-workflow-logs.md): **适用于**:Chatflow、Workflow。 - [流式获取工作流事件](https://docs.dify.ai/zh/api-reference/workflow-runs/stream-workflow-events.md): **适用于**:Chatflow、Workflow。 #### 会话管理 - [获取会话列表](https://docs.dify.ai/zh/api-reference/conversations/list-conversations.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 - [获取会话历史消息](https://docs.dify.ai/zh/api-reference/conversations/list-conversation-messages.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 - [获取会话变量](https://docs.dify.ai/zh/api-reference/conversations/list-conversation-variables.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [重命名会话](https://docs.dify.ai/zh/api-reference/conversations/rename-conversation.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 - [更新会话变量](https://docs.dify.ai/zh/api-reference/conversations/update-conversation-variable.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [删除会话](https://docs.dify.ai/zh/api-reference/conversations/delete-conversation.md): **适用于**:Chatflow、Agent、聊天助手、旧版 Agent。 #### 文件操作 - [上传文件](https://docs.dify.ai/zh/api-reference/files/upload-file.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 - [下载文件](https://docs.dify.ai/zh/api-reference/files/download-file.md): **适用于**:Chatflow、聊天助手、旧版 Agent、文本生成应用。 #### 语音与文字转换 - [语音转文字](https://docs.dify.ai/zh/api-reference/audio/convert-audio-to-text.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 - [文字转语音](https://docs.dify.ai/zh/api-reference/audio/convert-text-to-audio.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 #### 应用配置 - [获取应用基本信息](https://docs.dify.ai/zh/api-reference/applications/get-app-info.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 - [获取应用参数](https://docs.dify.ai/zh/api-reference/applications/get-app-parameters.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 - [获取应用元数据](https://docs.dify.ai/zh/api-reference/applications/get-app-meta.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 - [获取应用 WebApp 设置](https://docs.dify.ai/zh/api-reference/applications/get-app-webapp-settings.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 #### 消息反馈 - [提交消息反馈](https://docs.dify.ai/zh/api-reference/feedback/submit-message-feedback.md): **适用于**:Chatflow、聊天助手、旧版 Agent、文本生成应用。 - [获取应用的消息反馈](https://docs.dify.ai/zh/api-reference/feedback/list-app-feedbacks.md): **适用于**:Chatflow、聊天助手、旧版 Agent、文本生成应用。 #### 标注管理 - [创建标注](https://docs.dify.ai/zh/api-reference/annotations/create-annotation.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [获取标注列表](https://docs.dify.ai/zh/api-reference/annotations/list-annotations.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [更新标注](https://docs.dify.ai/zh/api-reference/annotations/update-annotation.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [删除标注](https://docs.dify.ai/zh/api-reference/annotations/delete-annotation.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [配置标注回复](https://docs.dify.ai/zh/api-reference/annotations/configure-annotation-reply.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 - [查询标注回复配置任务状态](https://docs.dify.ai/zh/api-reference/annotations/get-annotation-reply-job-status.md): **适用于**:Chatflow、聊天助手、旧版 Agent。 #### 终端用户 - [获取终端用户信息](https://docs.dify.ai/zh/api-reference/end-users/get-end-user-info.md): **适用于**:Chatflow、Workflow、Agent、聊天助手、旧版 Agent、文本生成应用。 #### 人工介入 - [获取人工介入表单](https://docs.dify.ai/zh/api-reference/human-input/get-human-input-form.md): **适用于**:Chatflow、Workflow。 - [提交人工介入表单](https://docs.dify.ai/zh/api-reference/human-input/submit-human-input-form.md): **适用于**:Chatflow、Workflow。 ### 知识库 API #### Agent 知识库 ##### 查询 - [创建查询令牌](https://docs.dify.ai/zh/api-reference/queries/create-query-token.md): 为 [运行查询](/zh/api-reference/queries/run-query) 签发查询令牌,并返回需随令牌一起发送的请求体。详见 [查询知识库](/zh/api-reference/guides/knowledge-base#query-the-knowledge-base)。 - [运行查询](https://docs.dify.ai/zh/api-reference/queries/run-query.md): 运行已通过 [创建查询令牌](/zh/api-reference/queries/create-query-token) 获取令牌的查询,并以 Server-Sent Events 流式返回回答。此接口以查询令牌作为凭据,不使用知识库 API 密钥。服务端在受理请求时校验令牌。 ##### 查询记录 - [获取查询记录列表](https://docs.dify.ai/zh/api-reference/query-records/list-query-records.md): 列出知识库的查询记录,最新的在前。每次调用 [运行查询](/zh/api-reference/queries/run-query),流一建立就会保存一条记录,之后失败的运行也不例外;但客户端断开连接,或运行以 `RETRIEVAL_EXECUTION_LEASE_LOST` 失败时,不保存记录。 - [获取查询记录](https://docs.dify.ai/zh/api-reference/query-records/get-query-record.md): 返回一条完整的查询记录:查询内容、检索深度、调用方,以及按执行顺序排列的流水线步骤及其元数据。`query.generate` 步骤的元数据内嵌了所有检索分段,因此响应可能较大(最大 2 MiB)。 - [获取查询分段列表](https://docs.dify.ai/zh/api-reference/query-records/list-query-chunks.md): 列出一次查询运行检索到的分段,每个分段一条,包含其主引用、分数、时效性和文本。 - [获取查询冲突列表](https://docs.dify.ai/zh/api-reference/query-records/list-query-conflicts.md): 列出一次查询运行所检索分段上记录的全部冲突,每个冲突一条。 - [获取缺失分段列表](https://docs.dify.ai/zh/api-reference/query-records/list-missing-chunks.md): 列出一次查询运行预期使用但未能使用的分段,每个分段一条。`data` 为空且 `truncated: false` 表示本次运行没有记录此类分段。 ##### 研究任务 - [获取研究任务列表](https://docs.dify.ai/zh/api-reference/research-tasks/list-research-tasks.md): 列出知识库中归属于当前 API 密钥的研究任务,最新的在前。 - [创建研究任务](https://docs.dify.ai/zh/api-reference/research-tasks/create-research-task.md): 为一个问题创建研究任务,返回的任务 `stage` 为 `queued`,随后在后台运行。规划、创建、轮询和读取结果的完整流程,详见 [运行研究任务](/zh/api-reference/guides/knowledge-base#run-a-research-task)。 - [规划研究任务](https://docs.dify.ai/zh/api-reference/research-tasks/plan-research-task.md): 估算研究任务,但不创建任务。返回实际采用的检索深度,以及成本、延迟和工作量的估算,包括是否在拟定的预算之内。 - [获取研究任务](https://docs.dify.ai/zh/api-reference/research-tasks/get-research-task.md): 返回研究任务的当前状态:`stage`、目前为止的花费、限制、时间戳,以及失败时的错误详情。 - [取消研究任务](https://docs.dify.ai/zh/api-reference/research-tasks/cancel-research-task.md): 取消尚未结束的研究任务,返回的任务 `stage` 为 `canceled`。 - [获取研究任务结果列表](https://docs.dify.ai/zh/api-reference/research-tasks/list-research-task-results.md): 列出研究任务目前已写入的结果,按 `sequence` 升序排列。 ##### 文档与分段 - [获取文档列表](https://docs.dify.ai/zh/api-reference/documents-and-chunks/list-documents.md): 列出知识库中的文档,最早的在前,包括每个文档的状态、自定义元数据、生效的修订版本和最近一次索引任务。 - [获取文档](https://docs.dify.ai/zh/api-reference/documents-and-chunks/get-document.md): 返回一个文档,包括其状态、自定义元数据、`row_version`、生效的修订版本和最近一次索引任务。 - [更新文档元数据](https://docs.dify.ai/zh/api-reference/documents-and-chunks/update-document-metadata.md): 将键合并到文档的 `user_metadata` 中,并返回更新后的文档。与此路径上的其他操作不同,它接收的是文档 ID,而不是文档文件 ID。 - [删除文档](https://docs.dify.ai/zh/api-reference/documents-and-chunks/delete-document.md): 请求删除一个文档,并返回删除作业。该操作会移除文档本身、其所有修订版本,以及仅由该文档使用的文档文件。作业完成后,该文档不再占用文档配额。 - [按文件获取文档](https://docs.dify.ai/zh/api-reference/documents-and-chunks/get-document-by-file.md): 返回文档 ID,以及由文档文件某个版本构建的修订版本。可用它从引用找到对应的文档:查询记录和研究任务结果通过 `documentAssetId` 和 `documentVersion` 引用文档文件。 - [获取文档文件列表](https://docs.dify.ai/zh/api-reference/documents-and-chunks/list-document-files.md): 列出知识库中存储的文档文件。返回的是文档文件 ID,而非文档 ID。如需列出文档,使用 [获取文档列表](/zh/api-reference/documents-and-chunks/list-documents)。 - [获取文档文件](https://docs.dify.ai/zh/api-reference/documents-and-chunks/get-document-file.md): 返回一个文档文件,即文档背后存储的文件,包括其 `version` 和 `parser_status`。 - [删除文档文件](https://docs.dify.ai/zh/api-reference/documents-and-chunks/delete-document-file.md): 请求删除一个文档文件,并返回删除作业。基于该文件构建的所有修订版本都不再通过 [获取分段列表](/zh/api-reference/documents-and-chunks/list-chunks) 返回分段。 - [获取文档大纲](https://docs.dify.ai/zh/api-reference/documents-and-chunks/get-document-outline.md): 返回为文档文件当前版本构建的标题树。 - [获取文档修订版本列表](https://docs.dify.ai/zh/api-reference/documents-and-chunks/list-document-revisions.md): 列出文档的修订版本,最新的在前。接收的是 [获取文档列表](/zh/api-reference/documents-and-chunks/list-documents) 返回的文档 ID,而不是文档文件 ID。 - [获取分段列表](https://docs.dify.ai/zh/api-reference/documents-and-chunks/list-chunks.md): 列出文档某个修订版本的分段,按分段 ID 排序,而非按在文档中的位置排序。接收 [获取文档列表](/zh/api-reference/documents-and-chunks/list-documents) 返回的文档 ID(而不是文档文件 ID),以及修订版本号。 - [获取分段](https://docs.dify.ai/zh/api-reference/documents-and-chunks/get-chunk.md): 返回文档某个修订版本中的一个分段。接收 [获取文档列表](/zh/api-reference/documents-and-chunks/list-documents) 返回的文档 ID(而不是文档文件 ID),以及修订版本号和分段 ID。 - [批量删除文档文件](https://docs.dify.ai/zh/api-reference/documents-and-chunks/delete-document-files-in-batch.md): 一次调用请求删除最多 100 个文档文件,并返回每个文件的处理结果。与 [删除文档文件](/zh/api-reference/documents-and-chunks/delete-document-file) 一样,不要删除生效修订版本的文件。 - [重新索引文档](https://docs.dify.ai/zh/api-reference/documents-and-chunks/re-index-documents.md): 为每个选中的文档排入一个索引任务,根据其当前文件重建索引。返回一个批量任务 ID,用于统一跟踪这些任务。 ##### 索引任务 - [获取索引任务](https://docs.dify.ai/zh/api-reference/indexing-tasks/get-indexing-task.md): 返回一个索引任务的状态。索引任务负责把文档文件的某个版本变成生效的修订版本。 - [取消索引任务](https://docs.dify.ai/zh/api-reference/indexing-tasks/cancel-indexing-task.md): 请求取消一个索引任务,并返回更新后的任务。 - [重试索引任务](https://docs.dify.ai/zh/api-reference/indexing-tasks/retry-indexing-task.md): 以同一个任务 ID 重新启动 `run_state` 为 `failed` 或 `canceled` 的索引任务,并返回更新后的任务。之后用同一个 ID 轮询 [获取索引任务](/zh/api-reference/indexing-tasks/get-indexing-task)。 - [获取批量任务](https://docs.dify.ai/zh/api-reference/indexing-tasks/get-bulk-task.md): 返回批量任务中各索引任务的进度。在此 API 中,批量任务来自 [重新索引文档](/zh/api-reference/documents-and-chunks/re-index-documents),并且只有启动它的 API 密钥才能读取。 - [获取文档的索引任务列表](https://docs.dify.ai/zh/api-reference/indexing-tasks/list-document-indexing-tasks.md): 列出文档因上传和同步产生的索引任务,最早的在前,每个任务都带有其结果。失败和已取消的任务也包括在内。 - [获取文档的索引任务](https://docs.dify.ai/zh/api-reference/indexing-tasks/get-document-indexing-task.md): 返回文档的一个索引任务及其进度。轮询直到 `state` 为 `succeeded`、`failed`、`canceled` 或 `superseded`。 - [获取后台任务列表](https://docs.dify.ai/zh/api-reference/indexing-tasks/list-background-tasks.md): 在同一个列表中汇总知识库的后台工作,或按 ID 查找指定任务: ##### 删除作业 - [获取删除作业](https://docs.dify.ai/zh/api-reference/deletion-jobs/get-deletion-job.md): 返回通过 [删除文档](/zh/api-reference/documents-and-chunks/delete-document)、[删除文档文件](/zh/api-reference/documents-and-chunks/delete-document-file) 或 [删除数据源](/zh/api-reference/sources/delete-source) 发起的删除进度,或 [批量删除文档文件](/zh/api-reference/documents-and-chunks/delete-document-files-in-batch) 中单个文件的删除进度。轮询直到 `ru… - [获取删除批次](https://docs.dify.ai/zh/api-reference/deletion-jobs/get-deletion-batch.md): 返回一次 [批量删除文档文件](/zh/api-reference/documents-and-chunks/delete-document-files-in-batch) 请求,包括每个文件的处理结果,以及每个已受理文件的删除作业当前状态。只有发送该批次的 API 密钥能读取它。 ##### 数据源 - [获取数据源连接列表](https://docs.dify.ai/zh/api-reference/sources/list-source-connections.md): 列出该知识库的连接,最早的在前。将某个连接的 `id` 作为 `connectionId` 传给 [创建数据源](/zh/api-reference/sources/create-source),即可添加通过该连接读取内容的数据源。 - [创建数据源](https://docs.dify.ai/zh/api-reference/sources/create-source.md): 添加一个通过现有连接读取内容的数据源,连接可通过 [获取数据源连接列表](/zh/api-reference/sources/list-source-connections) 查找。此操作不会抓取或导入任何内容。 - [获取数据源列表](https://docs.dify.ai/zh/api-reference/sources/list-sources.md): 按数据源 ID 升序列出知识库的数据源。每个数据源附带其定时同步设置、最近一次完成的同步或导入,以及当前运行;没有正在进行的运行时,改为附带最近一次同步。 - [获取数据源](https://docs.dify.ai/zh/api-reference/sources/get-source.md): 返回一个数据源的存储内容。 - [更新数据源](https://docs.dify.ai/zh/api-reference/sources/update-source.md): 更新数据源的名称、状态、URI、元数据或提供商参数;配置有变化时,可同时启动一次同步。 - [删除数据源](https://docs.dify.ai/zh/api-reference/sources/delete-source.md): 请求删除数据源,并返回删除作业。 - [测试数据源凭据](https://docs.dify.ai/zh/api-reference/sources/test-source-credentials.md): 由数据源提供商验证该数据源的凭据,并返回结果。不会对数据源做任何更改。 - [获取数据源页面列表](https://docs.dify.ai/zh/api-reference/sources/list-source-pages.md): 列出在线文档数据源在其提供商处可见的页面,按提供商工作空间分组。 - [获取数据源文件列表](https://docs.dify.ai/zh/api-reference/sources/list-source-files.md): 列出在线云盘数据源在其提供商处可见的存储桶和文件。 - [获取同步策略](https://docs.dify.ai/zh/api-reference/sources/get-sync-policy.md): 返回数据源的定时同步设置,以及 [更新同步策略](/zh/api-reference/sources/update-sync-policy) 所需的 `revision`。 - [更新同步策略](https://docs.dify.ai/zh/api-reference/sources/update-sync-policy.md): 设置数据源的定时同步,替换原有设置,并返回新设置。 ##### 数据源同步与导入 - [同步数据源](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/sync-source.md): 立即启动数据源同步,并返回运行。用其 `id` 轮询 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run),直到 `state` 为 `completed`、`failed` 或 `canceled`。 - [预览网站抓取](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/preview-website-crawl.md): 抓取网站数据源,并暂存找到的页面供你挑选,不导入任何内容。返回运行。用其 `id` 轮询 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run),直到 `state` 为 `preview_ready`、`zero_results`、`failed` 或 `canceled`。 - [获取抓取预览页面列表](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/list-crawl-preview-pages.md): 列出抓取预览发现的页面,以及传给 [导入所选页面](/zh/api-reference/source-syncs-and-imports/import-selected-pages) 所需的 `page_id`。不返回页面内容。 - [导入所选页面](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/import-selected-pages.md): 将抓取预览中的页面导入为文档,并返回同一个运行,此时它已排队等待导入。用相同的 `id` 轮询 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run),直到 `state` 为 `completed`、`failed` 或 `canceled`。 - [导入网站页面](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/import-website-pages.md): 将已知 URL 导入网站数据源,并返回运行。用其 `id` 轮询 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run),直到 `state` 为 `completed`、`failed` 或 `canceled`。 - [导入数据源条目](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/import-source-items.md): 将在线文档页面或在线云盘文件导入连接器数据源,并返回运行。用其 `id` 轮询 [获取数据源运行](/zh/api-reference/source-syncs-and-imports/get-source-run),直到 `state` 为 `completed`、`failed` 或 `canceled`。 - [获取数据源运行列表](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/list-source-runs.md): 列出知识库的数据源运行(同步、抓取预览和导入),包括由定时同步或在 Dify 中启动的运行。只列出该密钥可读取的数据源的运行。 - [获取数据源运行](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/get-source-run.md): 返回一个数据源运行。可按 ID 跟踪任意运行,包括 [获取数据源列表](/zh/api-reference/sources/list-sources) 不显示的抓取预览,以及从预览发起的导入。 - [取消数据源运行](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/cancel-source-run.md): 取消尚未结束的数据源运行,并返回该运行。 - [重试数据源运行](https://docs.dify.ai/zh/api-reference/source-syncs-and-imports/retry-source-run.md): 以相同的运行 ID,从头重新执行状态为 `failed` 或 `canceled` 的数据源运行,并返回已排队的运行。进度会重置,导入会重新获取每个条目,同步会从头开始。已选定页面的抓取预览会直接重新导入这些页面,不再抓取。 ##### 设置 - [获取知识库设置](https://docs.dify.ai/zh/api-reference/settings/get-knowledge-base-settings.md): 返回知识库的嵌入模型、检索设置、就绪状态,以及调用 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 时需要发送的 `revision`。 - [更新知识库设置](https://docs.dify.ai/zh/api-reference/settings/update-knowledge-base-settings.md): 更改知识库的嵌入模型或检索设置。在内容索引前后如何设置模型,详见 [更换模型或检索设置](/zh/api-reference/guides/knowledge-base#change-models-or-retrieval-settings)。 - [获取设置迁移](https://docs.dify.ai/zh/api-reference/settings/get-settings-migration.md): 返回迁移的进度。该迁移由 [更新知识库设置](/zh/api-reference/settings/update-knowledge-base-settings) 在返回 `202` 时启动。轮询直到 `run_state` 为 `succeeded`、`failed` 或 `canceled`。 #### 经典知识库 ##### 知识库 - [创建空知识库](https://docs.dify.ai/zh/api-reference/knowledge-bases/create-an-empty-knowledge-base.md): 创建一个空知识库。之后用 [从文本创建文档](/zh/api-reference/documents/create-document-by-text) 或 [从文件创建文档](/zh/api-reference/documents/create-document-by-file) 向其中添加文档。 - [获取知识库列表](https://docs.dify.ai/zh/api-reference/knowledge-bases/list-knowledge-bases.md): 返回工作空间中知识库的分页列表,不按知识库的权限设置过滤,可按关键词或标签筛选。 - [获取知识库详情](https://docs.dify.ai/zh/api-reference/knowledge-bases/get-knowledge-base.md): 返回知识库的详细信息,包括嵌入模型、检索配置和文档统计信息。 - [更新知识库](https://docs.dify.ai/zh/api-reference/knowledge-bases/update-knowledge-base.md): 更新知识库。仅更改请求体中包含的字段。 - [删除知识库](https://docs.dify.ai/zh/api-reference/knowledge-bases/delete-knowledge-base.md): 永久删除知识库、其中的所有文档,以及只绑定了该知识库的 API 密钥。同时绑定了其他知识库的密钥仍可继续访问那些知识库。 - [从知识库检索分段 / 测试检索](https://docs.dify.ai/zh/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval.md): 搜索知识库,返回与查询最相关的分段,可用于生产环境检索和测试检索。 ##### 文档 - [从文本创建文档](https://docs.dify.ai/zh/api-reference/documents/create-document-by-text.md): 在知识库中通过纯文本创建文档。索引异步进行;使用返回的 `batch` ID 通过 [获取文档嵌入状态(进度)](/zh/api-reference/documents/get-document-indexing-status) 跟踪。 - [从文件创建文档](https://docs.dify.ai/zh/api-reference/documents/create-document-by-file.md): 在知识库中通过上传文件创建文档。支持 PDF、TXT、DOCX 等常见格式。索引异步进行;使用返回的 `batch` ID 通过 [获取文档嵌入状态(进度)](/zh/api-reference/documents/get-document-indexing-status) 跟踪。 - [获取知识库的文档列表](https://docs.dify.ai/zh/api-reference/documents/list-documents.md): 返回知识库中文档的分页列表。 - [获取文档详情](https://docs.dify.ai/zh/api-reference/documents/get-document.md): 返回单个文档的详细信息。 - [删除文档](https://docs.dify.ai/zh/api-reference/documents/delete-document.md): 从知识库中永久删除文档及其所有分段。 - [更新文档](https://docs.dify.ai/zh/api-reference/documents/update-document.md): 通过上传新文件更新文档,然后重新索引。这是基于文件更新文档的规范端点。使用返回的 `batch` ID 通过 [获取文档嵌入状态(进度)](/zh/api-reference/documents/get-document-indexing-status) 跟踪进度。 - [下载文档](https://docs.dify.ai/zh/api-reference/documents/download-document.md): 返回用于下载文档原始上传文件的签名 URL。 - [获取文档嵌入状态(进度)](https://docs.dify.ai/zh/api-reference/documents/get-document-indexing-status.md): 返回批次中每个文档的索引进度:当前阶段和分段完成计数。轮询直到每个 `indexing_status` 变为 `completed` 或 `error`。状态按 `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed` 推进。 - [用文本更新文档](https://docs.dify.ai/zh/api-reference/documents/update-document-by-text.md): 更新文档的文本内容、名称或处理配置。文本变更时会重新索引文档。 - [用文件更新文档](https://docs.dify.ai/zh/api-reference/documents/update-document-by-file.md): 已弃用。改用 [更新文档](/zh/api-reference/documents/update-document)。通过上传新文件更新文档,然后重新索引。 - [批量下载文档(ZIP)](https://docs.dify.ai/zh/api-reference/documents/download-documents-as-zip.md): 将一个或多个文档下载为单个 ZIP 压缩包。仅可包含以文件形式上传的文档。 - [批量更新文档状态](https://docs.dify.ai/zh/api-reference/documents/update-document-status-in-batch.md): 在一次请求中批量启用、禁用、归档或取消归档多个文档。 ##### 分段 - [向文档添加分段](https://docs.dify.ai/zh/api-reference/chunks/create-chunks.md): 在文档中创建一个或多个分段。 - [从文档获取分段](https://docs.dify.ai/zh/api-reference/chunks/list-chunks.md): 返回文档内分段的分页列表,可按关键词或索引状态筛选。 - [获取文档中的分段详情](https://docs.dify.ai/zh/api-reference/chunks/get-chunk.md): 获取单个分段的完整详情。 - [更新文档中的分段](https://docs.dify.ai/zh/api-reference/chunks/update-chunk.md): 更新分段的字段。更新会为该分段重新触发索引。 - [删除文档中的分段](https://docs.dify.ai/zh/api-reference/chunks/delete-chunk.md): 从文档中永久删除一个分段。 - [创建子分段](https://docs.dify.ai/zh/api-reference/chunks/create-child-chunk.md): 在父分段下创建子分段。适用于使用父子(`hierarchical_model`)分块模式的文档。 - [获取子分段](https://docs.dify.ai/zh/api-reference/chunks/list-child-chunks.md): 返回特定父分段下子分段的分页列表。 - [更新子分段](https://docs.dify.ai/zh/api-reference/chunks/update-child-chunk.md): 更新现有子分段的内容。 - [删除子分段](https://docs.dify.ai/zh/api-reference/chunks/delete-child-chunk.md): 从父分段中永久删除一个子分段。 ##### 元数据 - [创建元数据字段](https://docs.dify.ai/zh/api-reference/metadata/create-metadata-field.md): 为知识库创建自定义元数据字段,用于给文档标注结构化信息。 - [获取元数据字段列表](https://docs.dify.ai/zh/api-reference/metadata/list-metadata-fields.md): 返回知识库的所有元数据字段(包括自定义和内置字段),以及使用每个字段的文档数量。 - [更新元数据字段](https://docs.dify.ai/zh/api-reference/metadata/update-metadata-field.md): 重命名自定义元数据字段。 - [删除元数据字段](https://docs.dify.ai/zh/api-reference/metadata/delete-metadata-field.md): 永久删除自定义元数据字段。使用过该字段的文档将丢失其对应的值。 - [获取内置元数据字段](https://docs.dify.ai/zh/api-reference/metadata/get-built-in-metadata-fields.md): 返回系统提供的内置元数据字段。 - [更新内置元数据字段](https://docs.dify.ai/zh/api-reference/metadata/update-built-in-metadata-field.md): 启用或禁用知识库的内置元数据字段。 - [批量更新文档元数据](https://docs.dify.ai/zh/api-reference/metadata/update-document-metadata-in-batch.md): 在一次请求中批量更新多个文档的元数据值。 ##### 标签 - [创建知识库标签](https://docs.dify.ai/zh/api-reference/tags/create-knowledge-tag.md): 创建用于组织知识库的标签。 - [获取知识库标签列表](https://docs.dify.ai/zh/api-reference/tags/list-knowledge-tags.md): 返回工作空间中所有的知识库标签。 - [修改知识库标签](https://docs.dify.ai/zh/api-reference/tags/update-knowledge-tag.md): 重命名知识库标签。 - [删除知识库标签](https://docs.dify.ai/zh/api-reference/tags/delete-knowledge-tag.md): 永久删除知识库标签。不会删除已被标记的知识库。 - [绑定标签到知识库](https://docs.dify.ai/zh/api-reference/tags/create-tag-binding.md): 将一个或多个标签绑定到知识库。一个知识库可以有多个标签。 - [解除标签与知识库的绑定](https://docs.dify.ai/zh/api-reference/tags/delete-tag-binding.md): 从知识库中移除一个或多个标签。 - [获取知识库绑定的标签](https://docs.dify.ai/zh/api-reference/tags/get-knowledge-base-tags.md): 返回绑定到知识库的标签。 ##### 模型 - [获取可用模型](https://docs.dify.ai/zh/api-reference/models/get-available-models.md): 返回指定类型的可用模型。用它查找可配置到知识库的 `text-embedding` 和 `rerank` 模型。 ##### 知识流水线 - [上传流水线文件](https://docs.dify.ai/zh/api-reference/knowledge-pipeline/upload-pipeline-file.md): 上传文件以在知识流水线中使用。将返回的 `id` 用作 [运行流水线](/zh/api-reference/knowledge-pipeline/run-pipeline) 中 `local_file` 项的 `reference`。 - [获取数据源插件列表](https://docs.dify.ai/zh/api-reference/knowledge-pipeline/list-datasource-plugins.md): 返回知识流水线中已配置的数据源节点,每个节点包含其使用的插件,以及运行该节点所需的元数据。 - [执行数据源节点](https://docs.dify.ai/zh/api-reference/knowledge-pipeline/run-datasource-node.md): 运行知识流水线中的单个数据源节点,并流式返回其执行事件。 - [运行流水线](https://docs.dify.ai/zh/api-reference/knowledge-pipeline/run-pipeline.md): 对一个或多个数据源运行完整的知识流水线。`response_mode` 选择流式或阻塞响应。 ## OpenAPI Specs - [openapi_service](/zh/api-reference/openapi_service.json)