Update Corpus Enablement API Definition

The Update Corpus Enablement API lets you enable or disable a corpus. This is useful to manage the availability of data within the system, such as when you need to take the corpus offline without having to delete the corpus.

This capability can help you utilize automated scripts to programmatically control the availability of corpora based on certain conditions. For example, quickly disable a corpus for maintenance updates or in response to security incidents.

tip

Check out our interactive API Playground that lets you experiment with this REST endpoint to enable or disable corpora.

Update Corpus Enablement Request and Response

The request to enable or disable a corpus requires corpus_id and setting enable to true or false.

REST Example

Update Corpus Enablement REST Endpoint Address

Vectara exposes a REST endpoint at the following URL to enable or disable a corpus:

https://api.vectara.io/v1/update-corpus-enablement

The API Playground shows the full Update Corpus Enablement REST definition.

gRPC Example

You can find the full Update Corpus Enablement gRPC definition at admin.proto.