Documents

Update Document Status in Batch

Enables, disables, archives, or unarchives multiple documents in one request.

patch/datasets/{dataset_id}/documents/status/{action}

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/datasets/{dataset_id}/documents/status/{action}
  • Auth
    HTTP bearer

Path parameters

dataset_idstring uuid required

Knowledge base ID, from List Knowledge Bases. For a scoped key, copy the ID from the Dify URL.

action'enable' | 'disable' | 'archive' | 'un_archive' required

enable activates documents for retrieval, disable deactivates them, archive moves them to the archive, un_archive restores them from the archive.

Request body

document_idsstring[] required

Document IDs to update. Get them from List Documents.

Response

Documents updated successfully.

resultstring

Operation result.

Changes

No recorded changes to this operation across all 17 revisions of this API.