Update Document Status in Batch

Enable, disable, archive, or unarchive multiple documents at once.

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

Error

A valid request URL is required to generate request examples

200

{
  "result": "success"
}

{
  "status": 400,
  "code": "invalid_action",
  "message": "Invalid action."
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Insufficient permissions."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}

Authorizations

Authorization · string · header · required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer . Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

dataset_id · string<uuid> · required

Knowledge base ID.

action · enum<string> · required

enable to activate, disable to deactivate, archive to archive, un_archive to restore from archive.

Available options: enable, disable, archive, un_archive

Body

application/json

document_ids · string[] · required

List of document IDs to update.

Response

200

application/json

Documents updated successfully.

result · string

Operation result.