Skip to main content
PATCH
/
datasets
/
{dataset_id}
/
documents
/
status
/
{action}
{
  "result": "success"
}

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

The ID of the knowledge base.

​
action
enum<string>
required

The action to perform on the documents.

Available options:
enable,
disable,
archive,
un_archive

Body

application/json
​
document_ids
string<uuid>[]
required

A list of document IDs to perform the action on.

Response

200 - application/json

Operation successful.

​
result
string
Example:

"success"