Delete Document(s) from a Corpus

DELETE

/api/v2/corpora/{corpus_id}/documents

Permanently marks documents within a specified corpus as deleted.

Purpose:

Facilitates bulk deletion of documents for a given corpus by setting a deletion flag.

Helps in cleaning up outdated or unnecessary documents from a corpus.

Operates on documents linked to the provided corpus_id.

Each document's is_deleted status will be updated to true.

Path Parameters:

corpus_id (int): Corpus ID

Query Parameters:

Optional:

source (str): The source of the document

Request Body:

Optional:

document_ids (list): The list of document ids to delete

Returns

A Success Message indicating the documents have been marked as deleted

If the user does not have permission to delete documents, the endpoint will return a 403 error

If the documents are not found, the endpoint will return a 404 error

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request DELETE 'https:///api/v2/corpora//documents?source=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Document deleted successfully",
    "data": {}
}

Get all Documents for a Corpus

Check Duplicate Documents in a Corpus