获取查询记录列表

列出知识库的查询记录，最新的在前。每次调用运行查询，流一建立就会保存一条记录，之后失败的运行也不例外；但客户端断开连接，或运行以 RETRIEVAL_EXECUTION_LEASE_LOST 失败时，不保存记录。

列表除了包含当前密钥产生的记录，还包含工作流、Agent、MCP 客户端和其他 API 密钥产生的记录。即使为每个租户分别使用一个密钥，列表也不会只显示该租户的运行。在 Dify 中进行的检索测试从不列出。

source 是唯一的筛选条件。如需日后再次定位某次运行，在查询时记下运行查询返回的 x-query-run-id 响应头。

如何结合查看一次运行的分段、冲突和缺失分段，详见排查回答。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/traces

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/traces')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "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
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "source"
      ],
      "type": "literal_error"
    }
  ]
}

{
  "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
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "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
}

{
  "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
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "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
}

get/knowledge-fs/spaces/{knowledge_base_id}/traces

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path parameters

knowledge_base_idstringrequired#

知识库 ID：即知识库 API 访问 对话框中所示服务 API 端点的最后一段（…/knowledge-fs/spaces/<knowledge base ID>），也是地址栏中 /datasets/new/ 之后的那一段。

Query parameters

cursorstring#

游标，取自上一页的 next_cursor。

Length: 1–1000

sourceenum<string>#

只返回某一类调用方产生的记录：service_api 表示 API 密钥，workflow 表示工作流节点，agent 或 mcp 表示相应的客户端。可以传 retrieval_test，但通过此 API 不会返回任何记录。

Options:retrieval_testworkflowservice_apiagentmcp

limitinteger#

每页记录数。

Default: 50

Range: 1–100

Responses

application/json

一页查询记录。

dataobject[]#

查询记录，最新的在前。

Show child attributes

completedboolean#

运行给出了回答时为 true，失败时为 false。列出的运行都已结束，因此 false 不表示仍在运行。

created_atstring#

运行的记录时间，ISO 8601 格式。

duration_msinteger#

运行耗时，单位为毫秒。未记录时为 null。

evidence_bundle_idstring#

该记录所引用的检索分段集合的 ID。没有任何操作接受此 ID，三个分段视图使用的是查询记录 ID。运行未记录检索分段时为 null。

evidence_statestring#

检索到的分段对回答的支撑程度：answerable、partial、not-enough-evidence、conflict 或 permission-limited。运行未记录检索分段时为 null。

final_scorenumber#

本次运行检索到的分段中最高的最终相关性分数，取值 0～1。没有计算分数时为 null。

idstring#

查询记录 ID，等于产生该记录的那次运行查询调用返回的 x-query-run-id 响应头。

modestring#

本次运行的检索深度：fast、deep 或 research。

open_bad_case_idstring#

在 Dify 的质量页面中针对此记录创建、尚未解决的问题案例的 ID。此 API 中没有任何操作接受此 ID。没有未解决的问题案例时为 null。

profileobject#

本次运行时生效的模型和索引版本。未记录的字段为 null。

Show child attributes

embedding_modelstring#

嵌入模型名称。

embedding_vector_space_idstring#

嵌入向量所在向量空间的 ID。

projection_publication_idstring#

本次运行所检索的已发布索引的 ID。比较不同记录中的这个值，即可判断两次运行是否检索了同一索引。

projection_versioninteger#

该已发布索引的版本。

reasoning_modelstring#

推理模型名称。

rerank_modelstring#

重排序模型名称。

retrieval_profile_revisioninteger#

运行时知识库检索设置的修订版本。

querystring#

查询文本。

query_imagesobject[]#

原始查询中使用的图片（如有）。纯文本查询不返回此字段。

Show child attributes

byte_sizeinteger#

文件大小（字节），无法获取时为 null。

Range: >= 0

mime_typestring#

媒体类型，无法获取时为 null。

namestring#

文件名。在服务 API 响应中可能为 null。

preview_urlstring#

预览 URL。在服务 API 响应中可能为 null，不要依赖它来显示图片。

upload_file_idstringrequired#

原始查询中所用图片文件的 ID。

result_countinteger#

本次运行返回的检索分段数。

scoresobject#

本次运行检索到的分段中各类分数的最高值，均为 0～1，未计算时为 null。

Show child attributes

finalnumber#

最终分数。

reranknumber#

重排序分数。

retrievalnumber#

检索分数。

sourcestring#

产生该记录的调用方：service_api（使用 API 密钥的调用方，包括此 API）、workflow（工作流节点）、agent、mcp 或 retrieval_test（Dify 中的检索测试）。

stagesobject[]#

本次运行所记录步骤的摘要，按执行顺序排列：包括每个步骤的名称、状态，以及候选数（如有）。如需步骤元数据（包括深度决策和回答摘要），用此记录的 ID 调用获取查询记录。

Show child attributes

candidate_countinteger#

该步骤记录的候选数。只有 Dify 检索测试会记录此值，因此其他记录中均为 null。

namestring#

步骤名称，例如 query.route、query.embed、query.retrieve、query.answer 或 query.generate。

statusstring#

ok、error 或 skipped。

next_cursorstring#

下一页的游标，最后一页时为 null。将其作为 cursor 传回。

运行查询获取查询记录