List Research Task Results

get/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials"
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}/research-tasks/{research_task_id}/partials', {
  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}/research-tasks/{research_task_id}/partials',
  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}/research-tasks/{research_task_id}/partials"

	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}/research-tasks/{research_task_id}/partials"))
    .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}/research-tasks/{research_task_id}/partials')

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": [
    {
      "answer": null,
      "evidence_bundle": {
        "createdAt": "2026-09-06T08:00:10.000Z",
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "items": [
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 2,
                "sectionPath": [
                  "Policies",
                  "Refunds"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
            "score": 0.82,
            "scores": {
              "final": 0.82,
              "rerank": 0.85,
              "retrieval": 0.71
            },
            "text": "From 1 March 2025, refunds are issued within 14 days of the return being received. The previous window was 30 days."
          },
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 3,
                "sectionPath": [
                  "Policies",
                  "Refunds",
                  "Regional exceptions"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09",
            "score": 0.77,
            "scores": {
              "final": 0.77,
              "rerank": 0.8,
              "retrieval": 0.66
            },
            "text": "The 14-day window applies to orders shipped to the EU and the UK. Other regions keep the 30-day window until further notice."
          }
        ],
        "missingEvidence": [],
        "query": "What changed in the 2025 refund policy, and which regions are affected?",
        "state": "partial"
      },
      "knowledge_space_id": "b2f1d3a4-5e6c-4a7b-8c9d-0e1f2a3b4c5d",
      "research_task_job_id": "e4d1b7a2-3c5f-4d8e-9a0b-1c2d3e4f5a6b",
      "sequence": 1
    },
    {
      "answer": "The 2025 policy shortened the refund window from 30 days to 14 days after the return is received, effective 1 March 2025. The change applies to orders shipped to the EU and the UK; other regions keep the 30-day window.",
      "evidence_bundle": {
        "createdAt": "2026-09-06T08:00:41.000Z",
        "id": "1f2e3d4c-5b6a-4978-8a7b-6c5d4e3f2a1b",
        "items": [
          {
            "citations": [
              {
                "artifactHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "endOffset": 1978,
                "pageNumber": 2,
                "sectionPath": [
                  "Policies",
                  "Refunds"
                ],
                "startOffset": 1840
              }
            ],
            "conflicts": [
              {
                "reason": "States a 14-day window while another chunk keeps 30 days for some regions.",
                "severity": "info",
                "withNodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09"
              }
            ],
            "freshness": {
              "observedAt": "2026-09-06T08:00:12.000Z",
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a",
            "score": 0.82,
            "scores": {
              "final": 0.82,
              "freshness": 0.9,
              "rerank": 0.85,
              "retrieval": 0.71
            },
            "text": "From 1 March 2025, refunds are issued within 14 days of the return being received. The previous window was 30 days."
          },
          {
            "citations": [
              {
                "documentAssetId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
                "documentVersion": 1,
                "pageNumber": 3,
                "sectionPath": [
                  "Policies",
                  "Refunds",
                  "Regional exceptions"
                ]
              }
            ],
            "conflicts": [],
            "freshness": {
              "observedAt": "2026-09-06T08:00:12.000Z",
              "sourceUpdatedAt": "2026-08-30T09:12:00.000Z",
              "status": "fresh"
            },
            "metadata": {},
            "nodeId": "c3b2a1f0-e9d8-4c7b-8a6f-5e4d3c2b1a09",
            "score": 0.77,
            "scores": {
              "final": 0.77,
              "freshness": 0.9,
              "rerank": 0.8,
              "retrieval": 0.66
            },
            "text": "The 14-day window applies to orders shipped to the EU and the UK. Other regions keep the 30-day window until further notice."
          }
        ],
        "missingEvidence": [
          {
            "expectedEvidenceId": "7e6d5c4b-3a29-4180-9f8e-7d6c5b4a3928",
            "metadata": {},
            "reason": "not-retrieved",
            "text": "No chunk lists the effective date for regions outside the EU and the UK."
          }
        ],
        "query": "What changed in the 2025 refund policy, and which regions are affected?",
        "retrievalQuery": "2025 refund policy changes refund window regions affected",
        "state": "answerable"
      },
      "knowledge_space_id": "b2f1d3a4-5e6c-4a7b-8c9d-0e1f2a3b4c5d",
      "research_task_job_id": "e4d1b7a2-3c5f-4d8e-9a0b-1c2d3e4f5a6b",
      "sequence": 2
    }
  ],
  "next_cursor": null
}

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

{
  "code": "knowledge_fs_invalid_request",
  "message": "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_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "602b9b60-6564-4ba7-8b59-54312d41377c"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "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": "ca5eb2d9-4242-4950-877c-6c5207b1441e"
  },
  "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}/research-tasks/{research_task_id}/partials

Authorization

Authorizationstringheaderrequired#

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_idstringrequired#

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.

research_task_idstringrequired#

Research task ID. From Create Research Task.

Query parameters

cursorstring#

Opaque cursor: send the previous page's next_cursor unchanged.

Length: 1–1000

limitinteger#

Entries per page.

Default: 25

Range: 1–100

Responses

application/json

One page of results.

dataobject[]#

Results in ascending sequence.

Show child attributes

answerstring#

The task's answer. Set only on the final result, and null on the retrieval checkpoint.

evidence_bundleobject#

Retrieved chunks the task had collected when this result was written.

An item whose document file was deleted after retrieval comes back as a placeholder:

text is Evidence deleted or unavailable.
citations[] keep only documentAssetId, documentVersion, and an empty sectionPath.
conflicts is empty.
freshness.status is unknown.
metadata.traceEvidenceAvailability is {"status": "unavailable", "reason": "document-deleted-or-unavailable"}.

Show child attributes

createdAtstring#

ISO 8601 timestamp when the bundle was written.

idstring#

ID of this bundle of retrieved chunks.

itemsobject[]#

Retrieved chunks with their scores and citations, best first.

Show child attributes

citationsobject[]#

Where the chunk comes from. At least one per item.

Show child attributes

artifactHashstring#

SHA-256 of the document file the citation points to. Absent when not recorded.

documentAssetIdstring#

Document file ID. Read the file's name with Get Document File. To find its document, pass it with documentVersion to Get Document by File.

documentVersioninteger#

The document file's version at retrieval time.

endOffsetinteger#

Zero-based UTF-8 byte offset in the parsed document text. Exclusive end. Omitted when unavailable.

pageNumberinteger#

Page number, starting at 1, when the source provides page information. Omitted otherwise.

sectionPathstring[]#

Section headings from the document root to the cited section.

startOffsetinteger#

Zero-based UTF-8 byte offset in the parsed document text. Inclusive start. Omitted when unavailable.

conflictsobject[]#

Disagreements between this chunk and other retrieved chunks. Empty when none.

Show child attributes

reasonstring#

What the conflict is about.

severitystring#

info, warning, or blocking.

withNodeIdstring#

nodeId of the chunk this one conflicts with. Absent when the conflict is not tied to one chunk.

freshnessobject#

How current the cited content is.

Show child attributes

observedAtstring#

ISO 8601 timestamp when the content was last seen. Absent when unknown.

sourceUpdatedAtstring#

ISO 8601 timestamp of the source's last update. Absent when unknown.

statusstring#

fresh, stale, or unknown.

metadataobject#

Additional item details. Carries traceEvidenceAvailability on placeholder items.

nodeIdstring#

ID of the retrieved chunk.

scorenumber#

Overall relevance from 0 to 1. The same value as scores.final.

scoresobject#

Score breakdown, each from 0 to 1.

Show child attributes

finalnumber#

Combined score used for ranking.

freshnessnumber#

Score for how recent the source is. Absent when not computed.

reranknumber#

Score from the rerank model. Absent when reranking did not run.

retrievalnumber#

Score from vector and keyword search.

textstring#

Chunk text.

missingEvidenceobject[]#

Chunks the run expected but could not use. Empty when none.

Show child attributes

expectedEvidenceIdstring#

ID of the expected chunk, when known.

metadataobject#

Additional details.

reasonstring#

not-retrieved, permission-filtered, stale, conflict, or unknown.

textstring#

What was missing.

querystring#

The research question.

retrievalQuerystring#

The query text actually sent to retrieval when it differs from query. Absent otherwise.

statestring#

How well the retrieved chunks support an answer: partial (the retrieval checkpoint, before analysis runs), answerable, not-enough-evidence, conflict (sources disagree), or permission-limited (permissions kept some chunks out).

traceIdstring#

ID of the run that produced the bundle, when one was recorded. A research task is not recorded as a query record, so Get Query Record does not take this ID.

knowledge_space_idstring#

Internal ID of the knowledge base. Not the knowledge base ID in the path.

research_task_job_idstring#

The research task ID.

sequenceinteger#

Position of the result within the task, starting at 1.

next_cursorstring#

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

Cancel Research Task List Documents