Indexing Tasks

List Document Indexing Tasks

Lists a document’s indexing tasks from uploads and syncs, oldest first, each with its outcome. Failed and canceled tasks are included.

The newest task is on the last page. For the task running now, read latest_task on Get Document instead.

An unknown document ID, including a document file ID, answers 200 with an empty data. A page can hold fewer than limit tasks, so follow next_cursor until it is null.

For which task operation to use when, see Track Indexing.

GET

knowledge-fs

spaces

{knowledge_base_id}

logical-documents

{document_id}

processing-tasks

List Document Indexing Tasks

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks"

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}/logical-documents/{document_id}/processing-tasks', 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}/logical-documents/{document_id}/processing-tasks",
  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}/logical-documents/{document_id}/processing-tasks"

	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))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks")

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": [
    {
      "active_operations": [
        "parse"
      ],
      "completed_at": "2026-09-03T10:03:40Z",
      "created_at": "2026-09-03T10:02:11Z",
      "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
      "document_revision": 1,
      "error_code": "DOCUMENT_COMPILATION_FAILED",
      "error_message": "The document could not be processed. Try again, or contact an administrator with the error reference.",
      "failure": {
        "action": "contact_admin",
        "category": "internal",
        "code": "DOCUMENT_COMPILATION_FAILED",
        "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
        "parameters": null,
        "retryPolicy": "manual",
        "stage": "parsing",
        "traceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
      },
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "phase": "parsing",
      "progress_percent": 0,
      "retry_at": null,
      "semantic_enrichment": {
        "error_code": null,
        "error_message": null,
        "failure": null,
        "nodes_completed": 0,
        "nodes_total": null,
        "provider_calls": null,
        "provider_calls_maximum": null,
        "state": "disabled",
        "updated_at": null
      },
      "stage": "queued",
      "state": "failed",
      "updated_at": "2026-09-03T10:03:40Z"
    },
    {
      "active_operations": [],
      "completed_at": "2026-10-20T08:16:05Z",
      "created_at": "2026-10-20T08:15:42Z",
      "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
      "document_revision": 2,
      "error_code": null,
      "error_message": null,
      "failure": null,
      "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "phase": "complete",
      "progress_percent": 100,
      "retry_at": null,
      "semantic_enrichment": {
        "error_code": null,
        "error_message": null,
        "failure": null,
        "nodes_completed": 18,
        "nodes_total": 18,
        "provider_calls": 12,
        "provider_calls_maximum": 200,
        "state": "ready",
        "updated_at": "2026-10-20T08:17:30Z"
      },
      "stage": "published",
      "state": "succeeded",
      "updated_at": "2026-10-20T08:17:30Z"
    }
  ],
  "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.

document_id

string<uuid>

required

The document ID, from List Documents.

Query Parameters

cursor

string

Cursor from the previous page's next_cursor.

Required string length: 1 - 1000

limit

integer

default:50

Tasks per page.

Required range: 1 <= x <= 100

Response

One page of indexing tasks.

data

object[]

One page of indexing tasks, oldest 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 Document Indexing Tasks

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks"

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}/logical-documents/{document_id}/processing-tasks', 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}/logical-documents/{document_id}/processing-tasks",
  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}/logical-documents/{document_id}/processing-tasks"

	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))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks")

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": [
    {
      "active_operations": [
        "parse"
      ],
      "completed_at": "2026-09-03T10:03:40Z",
      "created_at": "2026-09-03T10:02:11Z",
      "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
      "document_revision": 1,
      "error_code": "DOCUMENT_COMPILATION_FAILED",
      "error_message": "The document could not be processed. Try again, or contact an administrator with the error reference.",
      "failure": {
        "action": "contact_admin",
        "category": "internal",
        "code": "DOCUMENT_COMPILATION_FAILED",
        "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
        "parameters": null,
        "retryPolicy": "manual",
        "stage": "parsing",
        "traceId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
      },
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "phase": "parsing",
      "progress_percent": 0,
      "retry_at": null,
      "semantic_enrichment": {
        "error_code": null,
        "error_message": null,
        "failure": null,
        "nodes_completed": 0,
        "nodes_total": null,
        "provider_calls": null,
        "provider_calls_maximum": null,
        "state": "disabled",
        "updated_at": null
      },
      "stage": "queued",
      "state": "failed",
      "updated_at": "2026-09-03T10:03:40Z"
    },
    {
      "active_operations": [],
      "completed_at": "2026-10-20T08:16:05Z",
      "created_at": "2026-10-20T08:15:42Z",
      "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
      "document_revision": 2,
      "error_code": null,
      "error_message": null,
      "failure": null,
      "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "phase": "complete",
      "progress_percent": 100,
      "retry_at": null,
      "semantic_enrichment": {
        "error_code": null,
        "error_message": null,
        "failure": null,
        "nodes_completed": 18,
        "nodes_total": 18,
        "provider_calls": 12,
        "provider_calls_maximum": 200,
        "state": "ready",
        "updated_at": "2026-10-20T08:17:30Z"
      },
      "stage": "published",
      "state": "succeeded",
      "updated_at": "2026-10-20T08:17:30Z"
    }
  ],
  "next_cursor": null
}

Guides

App APIs

Knowledge APIs

List Document Indexing Tasks

Authorizations

Path Parameters

Query Parameters

Response