> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # 获取查询记录列表 > 列出知识库的查询记录，最新的在前。每次调用 [运行查询](/zh/api-reference/queries/run-query)，流一建立就会保存一条记录，之后失败的运行也不例外；但客户端断开连接，或运行以 `RETRIEVAL_EXECUTION_LEASE_LOST` 失败时，不保存记录。 列表除了包含当前密钥产生的记录，还包含工作流、Agent、MCP 客户端和其他 API 密钥产生的记录。即使为每个租户分别使用一个密钥，列表也不会只显示该租户的运行。在 Dify 中进行的检索测试从不列出。 `source` 是唯一的筛选条件。如需日后再次定位某次运行，在查询时记下 [运行查询](/zh/api-reference/queries/run-query) 返回的 `x-query-run-id` 响应头。 如何结合查看一次运行的分段、冲突和缺失分段，详见 [排查回答](/zh/api-reference/guides/knowledge-base#investigate-an-answer)。 ## OpenAPI ````yaml /zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces openapi: 3.0.1 info: description: 用于 Dify 应用与知识库的 REST API。应用类接口使用应用 API 密钥认证，知识库类接口使用知识库 API 密钥认证。 title: Dify 服务 API version: 1.0.0 servers: - description: Dify 服务 API 的基础 URL。自部署时，替换为你的 API 基础 URL。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API 基础 URL 的主机与路径，不含 `https://` 前缀。 security: - ApiKeyAuth: [] tags: - description: 与聊天消息和交互相关的操作。 name: 对话消息 - description: 文件上传和预览操作。 name: 文件操作 - description: 终端用户信息相关操作。 name: 终端用户 - description: 用户反馈操作。 name: 消息反馈 - description: 与管理会话相关的操作。 name: 会话管理 - description: 文字转语音和语音转文字操作。 name: 语音与文字转换 - description: 获取应用设置和信息的操作。 name: 应用配置 - description: 与管理标注直接回复相关的操作。 name: 标注管理 - description: 暂停等待人工输入的工作流恢复操作。 name: 人工介入 - description: 用于执行和管理工作流的操作。 name: 工作流运行 - description: 文本生成相关操作。 name: 文本生成消息 - description: 用于管理知识库的操作，包括创建、配置和检索。 name: 知识库 - description: 用于在知识库中创建、更新和管理文档的操作。 name: 文档 - description: 用于管理分段和子分段的操作。 name: 分段 - description: 用于管理知识库元数据字段和文档元数据值的操作。 name: 元数据 - description: 用于管理知识库标签和标签绑定的操作。 name: 标签 - description: 用于获取可用模型的操作。 name: 模型 - description: 用于管理和运行知识流水线的操作，包括数据源插件和流水线执行。 name: 知识流水线 - description: 向知识库提问，并流式返回回答。 name: 查询 - description: 查看一次查询检索到了什么，以及原因。 name: 查询记录 - description: 在后台运行研究问题，并获取其结果。 name: 研究任务 - description: 读取知识库中的文档及其文件、修订版本和分段，并用元数据标注文档。 name: 文档与分段 - description: 跟踪、取消或重试索引，并列出知识库的后台任务。 name: 索引任务 - description: 跟踪文档文件、一批文件或数据源的删除，直到完成。 name: 删除作业 - description: 管理为知识库提供内容的数据源，以及它们的定时同步设置和连接。 name: 数据源 - description: 立即同步数据源，导入网站页面或提供商条目，并跟踪、取消或重试运行。 name: 数据源同步与导入 - description: 读取和更改知识库的模型与检索设置，并跟踪更改触发的迁移。 name: 设置 paths: /knowledge-fs/spaces/{knowledge_base_id}/traces: get: tags: - Query Records summary: 获取查询记录列表 description: >- 列出知识库的查询记录，最新的在前。每次调用 [运行查询](/zh/api-reference/queries/run-query)，流一建立就会保存一条记录，之后失败的运行也不例外；但客户端断开连接，或运行以 `RETRIEVAL_EXECUTION_LEASE_LOST` 失败时，不保存记录。 列表除了包含当前密钥产生的记录，还包含工作流、Agent、MCP 客户端和其他 API 密钥产生的记录。即使为每个租户分别使用一个密钥，列表也不会只显示该租户的运行。在 Dify 中进行的检索测试从不列出。 `source` 是唯一的筛选条件。如需日后再次定位某次运行，在查询时记下 [运行查询](/zh/api-reference/queries/run-query) 返回的 `x-query-run-id` 响应头。 如何结合查看一次运行的分段、冲突和缺失分段，详见 [排查回答](/zh/api-reference/guides/knowledge-base#investigate-an-answer)。 operationId: listQueryRecords parameters: - description: >- 知识库 ID：即知识库 **API 访问** 对话框中所示服务 API 端点的最后一段（`…/knowledge-fs/spaces/`），也是地址栏中 `/datasets/new/` 之后的那一段。 in: path name: knowledge_base_id required: true schema: format: uuid type: string - description: 游标，取自上一页的 `next_cursor`。 in: query name: cursor required: false schema: maxLength: 1000 minLength: 1 type: string - description: >- 只返回某一类调用方产生的记录：`service_api` 表示 API 密钥，`workflow` 表示工作流节点，`agent` 或 `mcp` 表示相应的客户端。可以传 `retrieval_test`，但通过此 API 不会返回任何记录。 in: query name: source required: false schema: enum: - retrieval_test - workflow - service_api - agent - mcp type: string - description: 每页记录数。 in: query name: limit required: false schema: default: 50 maximum: 100 minimum: 1 type: integer responses: '200': content: application/json: examples: success: summary: 响应示例 value: data: - completed: true created_at: '2026-09-06T08:00:01.840000Z' duration_ms: 1840 evidence_bundle_id: 7d1f4c2e-8b3a-4e6d-9f0a-2b3c4d5e6f70 evidence_state: answerable final_score: 0.82 id: 3c9e3b1a-2f0a-4b7d-9d3e-1f2a3b4c5d6e mode: fast open_bad_case_id: null profile: embedding_model: text-embedding-3-large embedding_vector_space_id: >- embedding-space-sha256:7b2e4c9a1d3f5e6071829a3b4c5d6e7f8091a2b3c4d5e6f708192a3b4c5d6e7f projection_publication_id: f0a2c4e6-8b0d-4f2a-9c4e-6a8b0c2d4e6f projection_version: 4 reasoning_model: gpt-4.1 rerank_model: bge-reranker-v2-m3 retrieval_profile_revision: 2 query: What is the refund window? result_count: 6 scores: final: 0.82 rerank: 0.85 retrieval: 0.71 source: service_api stages: - candidate_count: null name: query.route status: ok - candidate_count: null name: query.retrieve status: ok - candidate_count: null name: query.generate status: ok next_cursor: null schema: properties: data: description: 查询记录，最新的在前。 items: properties: completed: description: >- 运行给出了回答时为 `true`，失败时为 `false`。列出的运行都已结束，因此 `false` 不表示仍在运行。 type: boolean created_at: description: 运行的记录时间，ISO 8601 格式。 type: string duration_ms: description: 运行耗时，单位为毫秒。未记录时为 `null`。 nullable: true type: integer evidence_bundle_id: description: >- 该记录所引用的检索分段集合的 ID。没有任何操作接受此 ID，三个分段视图使用的是查询记录 ID。运行未记录检索分段时为 `null`。 nullable: true type: string evidence_state: description: >- 检索到的分段对回答的支撑程度：`answerable`、`partial`、`not-enough-evidence`、`conflict` 或 `permission-limited`。运行未记录检索分段时为 `null`。 nullable: true type: string final_score: description: 本次运行检索到的分段中最高的最终相关性分数，取值 0～1。没有计算分数时为 `null`。 nullable: true type: number id: description: >- 查询记录 ID，等于产生该记录的那次 [运行查询](/zh/api-reference/queries/run-query) 调用返回的 `x-query-run-id` 响应头。 type: string mode: description: 本次运行的检索深度：`fast`、`deep` 或 `research`。 type: string open_bad_case_id: description: >- 在 Dify 的 **质量** 页面中针对此记录创建、尚未解决的问题案例的 ID。此 API 中没有任何操作接受此 ID。没有未解决的问题案例时为 `null`。 nullable: true type: string profile: description: 本次运行时生效的模型和索引版本。未记录的字段为 `null`。 properties: embedding_model: description: 嵌入模型名称。 nullable: true type: string embedding_vector_space_id: description: 嵌入向量所在向量空间的 ID。 nullable: true type: string projection_publication_id: description: 本次运行所检索的已发布索引的 ID。比较不同记录中的这个值，即可判断两次运行是否检索了同一索引。 nullable: true type: string projection_version: description: 该已发布索引的版本。 nullable: true type: integer reasoning_model: description: 推理模型名称。 nullable: true type: string rerank_model: description: 重排序模型名称。 nullable: true type: string retrieval_profile_revision: description: 运行时知识库检索设置的修订版本。 nullable: true type: integer type: object query: description: 查询文本。 type: string query_images: description: 原始查询中使用的图片（如有）。纯文本查询不返回此字段。 items: properties: byte_size: description: 文件大小（字节），无法获取时为 `null`。 minimum: 0 nullable: true type: integer mime_type: description: 媒体类型，无法获取时为 `null`。 nullable: true type: string name: description: 文件名。在服务 API 响应中可能为 `null`。 nullable: true type: string preview_url: description: 预览 URL。在服务 API 响应中可能为 `null`，不要依赖它来显示图片。 nullable: true type: string upload_file_id: description: 原始查询中所用图片文件的 ID。 type: string required: - upload_file_id type: object type: array result_count: description: 本次运行返回的检索分段数。 type: integer scores: description: 本次运行检索到的分段中各类分数的最高值，均为 0～1，未计算时为 `null`。 properties: final: description: 最终分数。 nullable: true type: number rerank: description: 重排序分数。 nullable: true type: number retrieval: description: 检索分数。 nullable: true type: number type: object source: description: >- 产生该记录的调用方：`service_api`（使用 API 密钥的调用方，包括此 API）、`workflow`（工作流节点）、`agent`、`mcp` 或 `retrieval_test`（Dify 中的检索测试）。 type: string stages: description: >- 本次运行所记录步骤的摘要，按执行顺序排列：包括每个步骤的名称、状态，以及候选数（如有）。如需步骤元数据（包括深度决策和回答摘要），用此记录的 ID 调用 [获取查询记录](/zh/api-reference/query-records/get-query-record)。 items: properties: candidate_count: description: 该步骤记录的候选数。只有 Dify 检索测试会记录此值，因此其他记录中均为 `null`。 nullable: true type: integer name: description: >- 步骤名称，例如 `query.route`、`query.embed`、`query.retrieve`、`query.answer` 或 `query.generate`。 type: string status: description: '`ok`、`error` 或 `skipped`。' type: string type: object type: array type: object type: array next_cursor: description: 下一页的游标，最后一页时为 `null`。将其作为 `cursor` 传回。 nullable: true type: string type: object description: 一页查询记录。 '400': content: application/json: examples: knowledge_fs_invalid_request: summary: knowledge_fs_invalid_request (local validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - source type: literal_error knowledge_fs_invalid_request_2: summary: knowledge_fs_invalid_request (upstream) value: code: knowledge_fs_invalid_request failure: category: validation code: KNOWLEDGE_FS_INVALID_REQUEST message: The Agent Knowledge Base request is invalid. retryPolicy: never traceId: 8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2 message: The Agent Knowledge Base request is invalid. status: 400 description: |- - `knowledge_fs_invalid_request`：请求未通过校验。`violations` 列出每个出错的字段。 - `knowledge_fs_invalid_request`：无法解码 `cursor`。 '401': content: application/json: examples: knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 unauthorized: summary: unauthorized value: code: unauthorized message: Access token is invalid status: 401 description: >- - `unauthorized`：缺少 `Authorization` 请求头，或密钥无法识别、不是知识库 API 密钥。 - `knowledge_fs_invalid_credential`：密钥有效，但其所属工作空间中没有此 ID 的知识库，或该密钥未关联任何工作空间。 '403': content: application/json: examples: forbidden: summary: forbidden (rate limit) value: code: forbidden message: >- Sorry, you have reached the knowledge base request rate limit of your subscription. status: 403 knowledge_fs_access_denied: summary: knowledge_fs_access_denied value: code: knowledge_fs_access_denied message: Agent Knowledge Base operation is not allowed. status: 403 description: >- - `knowledge_fs_access_denied`：该密钥的访问范围限定为其他知识库、此知识库已关闭 **API 访问**，或知识库未处于活动状态。 - `forbidden`：在 Dify Cloud 上，工作空间已达到其订阅套餐的知识库请求频率限制。所有调用都计入，读取操作也不例外。 '404': content: application/json: examples: knowledge_fs_resource_not_found: summary: knowledge_fs_resource_not_found value: code: knowledge_fs_resource_not_found failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 8f3a2c14-9d6b-4c07-b5a1-2e7d0c93f5b2 message: The requested Agent Knowledge Base resource was not found. status: 404 not_found: summary: not_found (feature off) value: code: not_found message: >- The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. status: 404 description: |- - `knowledge_fs_resource_not_found`：无法识别该知识库 ID。 - `not_found`：当前部署已关闭 Agent 知识库功能。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: '- `knowledge_fs_upstream_unavailable`：未能及时收到响应，或无法读取响应。稍候重试。' '503': content: application/json: examples: knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 knowledge_fs_operation_unavailable_upstream: summary: knowledge_fs_operation_unavailable (temporary) value: code: knowledge_fs_operation_unavailable failure: action: retry category: dependency code: KNOWLEDGE_FS_UNAVAILABLE message: >- A service required by Agent Knowledge Base is temporarily unavailable. retryPolicy: manual traceId: 5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b message: >- A service required by Agent Knowledge Base is temporarily unavailable. status: 503 description: >- - `knowledge_fs_operation_unavailable`：此工作空间尚未配置 Agent 知识库功能、当前部署不提供此操作，或在请求鉴权期间该密钥对此知识库的访问权限发生了变化。 - `knowledge_fs_operation_unavailable`：暂时无法处理该请求。按 `failure.retryPolicy` 处理。 components: securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- 每个请求都通过 API Key 认证：`Authorization: Bearer {API_KEY}`。应用接口使用应用 API Key，知识库接口使用知识库 API Key（[快速开始](/zh/api-reference/guides/get-started)）。 API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP `401`（`unauthorized`）。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.