Sign in

v1

latestOpenAPI 3.0.02026-07-1329122146.2 KB
IndexService

Delete documents from a corpus.

Some tips for this API:

  • This operation authenticates with either the Personal API Key, Index API Key, or OAuth 2.0 (in a JWT "Bearer Token"). You can find details of how to set up an API key or use OAuth 2.0 here.
  • You can quickly delete all documents from a corpus to clear it out by using the Reset Corpus operation.
post/v1/delete-doc

Headers

customer-idinteger required

Enter the Customer ID to use for the request.

timeoutstring

(Optional) Enter the timeout value of the request in seconds, such as 10S or 30S.

Request body

customerIdstring int64 required

The Customer ID to issue the request for.

corpusIdstring int64 required

The Corpus ID that contains the document.

documentIdstring required

The Document ID to be deleted.

Response

A successful response.

VectaraDeleteDocumentResponse required