Query Records

List Query Records

Lists the query records of a knowledge base, newest first. Each Run Query call saves a record once its stream opens, including a run that then fails, unless the client disconnected or the run failed with RETRIEVAL_EXECUTION_LEASE_LOST.

The list contains the records this key produced plus records produced by workflows, agents, MCP clients, and other API keys. A separate key for each tenant does not limit this list to that tenant’s runs. Retrieval tests run in Dify are never listed.

source is the only filter. Capture the x-query-run-id header of Run Query at query time to reach one run again.

For how to read a run’s chunks, conflicts, and missing chunks together, see Investigate an Answer.

GET

knowledge-fs

spaces

{knowledge_base_id}

traces

List Query Records

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{api_base_url}/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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

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

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

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

Authorizations

Authorization

string

header

required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

knowledge_base_id

string<uuid>

required

Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's API Access dialog (…/knowledge-fs/spaces/<knowledge base ID>), and the segment after /datasets/new/ in the address bar.

Query Parameters

cursor

string

Cursor from the previous page's next_cursor.

Required string length: 1 - 1000

source

enum<string>

Return only records produced by one kind of caller: service_api for API keys, workflow for workflow nodes, agent or mcp for those clients. retrieval_test is accepted but returns no records through this API.

Available options:

retrieval_test,

workflow,

service_api,

agent,

mcp

limit

integer

default:50

Records per page.

Required range: 1 <= x <= 100

Response

One page of query records.

data

object[]

Query records, newest first.

Show child attributes

next_cursor

string | null

Cursor for the next page, or null on the last page. Send it back as cursor.

List Query Records

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{api_base_url}/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))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/traces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

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

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

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

Guides

App APIs

Knowledge APIs

List Query Records

Authorizations

Path Parameters

Query Parameters

Response