Get Document Indexing Task

Returns one indexing task of a document, with its progress. Poll it until state is succeeded, failed, canceled, or superseded.

For a task started by Re-index Documents, poll Get Indexing Task with compilation_job.id instead.

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

GET /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}

Get Document Indexing Task

cURL

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

200

success

{
  "active_operations": [
    "chunk",
    "fts_index",
    "embedding"
  ],
  "completed_at": null,
  "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": "chunking_indexing",
  "progress_percent": 35,
  "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": "not_scheduled",
    "updated_at": null
  },
  "stage": "outline_built",
  "state": "running",
  "updated_at": "2026-10-20T08:15:58Z"
}

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.

task_id · string<uuid> · required

Indexing task ID: latest_task.id from Get Document or List Documents, or id from List Document Indexing Tasks. The task must belong to this document.

Response

200

application/json

The indexing task.

active_operations · string[] | null

Operations under way in the current phase, such as parse, chunk, embedding, or publication.

completed_at · string | null

When the task ended, ISO 8601. null while it runs.

created_at · string

When the task was created, ISO 8601. Get Indexing Task reports the same task's times in epoch milliseconds.

document_id · string

Document ID.

document_revision · integer

Revision this task builds.

error_code · string | null

Error code when state is failed.

error_message · string | null

The message for error_code. Can differ from failure.message.

failure · object | null

Error details when state is failed. stage is the phase the task failed in, and traceId is the task ID. null otherwise.

Show child attributes

id · string

Indexing task ID. The same ID works with Get Indexing Task, Cancel Indexing Task, and Retry Indexing Task.

knowledge_space_id · string

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

phase · string | null

What the task is doing: queued, parsing, outline_summary, chunking_indexing, graph_admission, publication, or complete.

progress_percent · integer

Progress from 0 to 100, derived from stage.

retry_at · string | null

When the automatic retry runs, ISO 8601. Set while state is retry_wait.

semantic_enrichment · object | null

Knowledge graph building after the revision publishes. Indexing finishes the knowledge graph before publishing, so it doesn't schedule this step. state is not_scheduled while the task runs and disabled once it has ended. nodes_completed stays 0.

Show child attributes

stage · string

Last checkpoint reached, in forward order: queued, parsed, outline_built, nodes_generated, projection_built, smoke_eval_passed, published. It stays at the last checkpoint when the task fails or is canceled, so read state for the outcome.

state · string

Run state:

• dispatch_pending, queued: waiting for a worker.
• retry_wait: an automatic retry is scheduled at retry_at.
• running: a worker is indexing.
• succeeded: the revision is published and serves queries.
• failed: see failure. Restart it with Retry Indexing Task.
• canceled.
• superseded: a newer attempt replaced this one.

succeeded, failed, canceled, and superseded are terminal.

updated_at · string

When the task last changed, ISO 8601.