IndexService

POST /v1/delete-doc

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.

Request

Base URL
https://api.vectara.io
Auth
- API key in header x-api-key
- or OAuth 2
  Client credentials
  Token URLhttps://vectara-prod-YOUR_VECTARA_CUSTOMER_ID.auth.us-west-2.amazoncognito.com/oauth2/token
TypeScript
https://skmtc.dev/vectara/apis/vectara-rest-api/docs/v1/delete-doc/post.ts
A function with typed inputs. Its response is checked against the schema.

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.

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.

A successful response.

VectaraDeleteDocumentResponse required

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