Skip to main content
Version: 1.0

Delete

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

Header Parameters

    customer-id integerrequired

    Enter the Customer ID to use for the request.

    timeout string

    Default value: 30S

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

Body

required

Request to delete a document from an index.

    customerId int64required

    The Customer ID to issue the request for.

    corpusId int64required

    Possible values: >= 1

    The Corpus ID that contains the document.

    documentId stringrequired

    The Document ID to be deleted.

Responses

A successful response.

Schema

    object

Loading...