Skip to main content
Version: 2.0

Corpus Administration

The Vectara Console is a good way for you to get started with Vectara. Once you're ready to integrate the platform more deeply into your application, the Corpus Admin APIs allow you to programmatically manipulate corpora and perform many other operations within the system. These APIs enable new workflows for organizations, like managing corpora and tracking usage of accounts and corpora. Check out this blog post about managing multi-tenancy for more details.

tip

The interactive API Reference lets you experiment with these API endpoints.

Create, Delete, and Reset Corpus API Definitions​

The full definitions of the Create, Reset, and Delete gRPC APIs are covered in admin.proto.

  • The Create Corpus API allows corpora to be created programmatically, up to the limit defined for the account.
  • The Reset Corpus API deletes all data from a corpus, without deleting its definition.
  • The Delete Corpus API expunges both the data in the corpus and its definition.

Corpus Management API Definitions​

The Corpus Management API definitions enable administrators to track usage of their accounts and corpora.

  • The Get Corpus API enables you to retrieve metadata about a specific corpus, including its limits and usage information, and the number of documents and document parts in the corpus.
  • The List Corpora API enables you to list all corpora in your account, with pagination support.
  • The Update Corpus API enables you to modify corpus settings, such as enabling/disabling the corpus or updating its name, description, and filter attributes.
  • The Replace Corpus Filter Attributes API enables you to replace the filter attributes of a corpus asynchronously.

The REST APIs are designed to be intuitive and follow RESTful principles. They use standard HTTP methods (GET, POST, PATCH, DELETE) for CRUD operations.