Get Document

Returns one document: its status, custom metadata, row_version, active revision, and latest indexing task.

For how document IDs and document file IDs relate, see Browse Documents and Chunks.

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

Get Document

cURL

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

200

success

{
  "active": {
    "activated_at": "2026-10-20T08:16:05Z",
    "content_hash": "4f7c2d9a1b3e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4",
    "created_at": "2026-10-20T08:15:42Z",
    "document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
    "document_asset_version": 1,
    "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
    "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
    "mime_type": "application/pdf",
    "revision": 2,
    "size_bytes": 482113,
    "state": "active"
  },
  "active_revision": 2,
  "created_at": "2026-09-03T10:02:11Z",
  "disabled_at": null,
  "disabled_by_subject_id": null,
  "enabled": true,
  "id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
  "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
  "latest_task": {
    "can_cancel": false,
    "can_retry": false,
    "completed_at": "2026-10-20T08:16:05Z",
    "created_at": "2026-10-20T08:15:42Z",
    "document_id": "2f6b8d1a-7c3e-4a5b-9d0e-1f2a3b4c5d6e",
    "document_revision": 2,
    "document_title": null,
    "error_code": null,
    "error_message": null,
    "failure": null,
    "failures": null,
    "id": "c4e8a2f6-1b3d-4e5f-8a9b-0c1d2e3f4a5b",
    "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
    "operation": "document_processing",
    "progress_completed": 1,
    "progress_failed": 0,
    "progress_percent": 100,
    "progress_total": 1,
    "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
    },
    "source_id": null,
    "source_title": null,
    "state": "completed",
    "task_kind": "document",
    "updated_at": "2026-10-20T08:16:05Z"
  },
  "provider_item_id": null,
  "row_version": 4,
  "source_id": null,
  "status": "ready",
  "title": "handbook.pdf",
  "updated_at": "2026-10-20T08:16:05Z",
  "user_metadata": {
    "owner": "support-team",
    "product_line": "billing",
    "review_date": "2026-12-01T00:00:00Z"
  }
}

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.

Response

200

application/json

The document.

active · object | null

The active revision: the content the knowledge base serves. Pass its revision to List Chunks and its document_asset_id to Get Document File. null while no revision is active.

Show child attributes

active_revision · integer | null

Number of the active revision. null while none is active.

created_at · string

When the document was created, ISO 8601.

disabled_at · string | null

When the document was disabled in Dify, ISO 8601.

disabled_by_subject_id · string | null

Internal ID of whoever disabled the document. Not needed to call this API.

enabled · boolean

false after the document is disabled in Dify. Re-index Documents skips disabled documents.

id · string

Document ID. It stays the same when the document's content is updated.

knowledge_space_id · string

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

latest_task · object | null

The newest indexing task behind the document's revisions, with task_kind: document. Follow it with Get Document Indexing Task using its id. null when there is none, and always null in the Update Document Metadata response.

Show child attributes

provider_item_id · string | null

For a document imported from a source, the item's identifier there: the providerItemId sent to Import Source Items, or the page_id of a website page.

row_version · integer

Change counter. Send it as expectedRowVersion on Update Document Metadata, and as expectedRevision on Delete Document. It increases on metadata updates, when a new revision becomes active or the active revision's file is deleted, when the document's source is deleted with documents=keep, and when the document is enabled or disabled in Dify.

source_id · string | null

Source the document came from. null for uploaded files.

status · string

pending (no revision active yet), ready (a revision is active), failed (the first revision failed to index and none is active), or deleting. A ready document stays ready when a later revision fails.

title · string

Document title.

updated_at · string

When the document last changed, ISO 8601.

user_metadata · object

Custom metadata, keyed by metadata field name. Change it with Update Document Metadata or in Dify.