索引任务

获取文档的索引任务列表

列出文档因上传和同步产生的索引任务，最早的在前，每个任务都带有其结果。失败和已取消的任务也包括在内。

最新的任务在最后一页。如需查看当前正在运行的任务，改为读取获取文档中的 latest_task。

未知的文档 ID（包括文档文件 ID）会返回 200，data 为空。一页中的任务可能少于 limit 个，因此要沿 next_cursor 一直翻页，直到它为 null。

各任务操作的适用场景，详见跟踪索引进度。

GET

knowledge-fs

spaces

{knowledge_base_id}

logical-documents

{document_id}

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

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

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

document_id

string<uuid>

required

文档 ID，从获取文档列表获取。

Query Parameters

cursor

string

游标，取自上一页的 next_cursor。

Required string length: 1 - 1000

limit

integer

default:50

每页任务数。

Required range: 1 <= x <= 100

Response

一页索引任务。

data

object[]

一页索引任务，最早的在前。

Show child attributes

next_cursor

string | null

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

获取文档的索引任务列表

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
}