Skip to main content
Version: 2.0

Get Corpus API Definition

The Get Corpus API lets you view metadata about a specific corpus. This is useful for getting information about a corpus without performing a search.

This capability helps administrators understand the access control details and monitor the size of corpora to understand information like the amount of quota consumed. You can also use this information for optimizing search and storage utilization.

For example, you can track the read and write activity of a specific corpus which can help you change your security strategy proactively. You noticed a corpus with an API key with read/write access that is only being used for high volume reads. You may decide to switch to a read-only key.

In another case, you might respond to a security incident by disabling a specific corpus because of information returned by this endpoint.

Get Corpus Metadata Request and Response​

To get corpus metadata, send a GET request to /v2/corpora/:corpus_key, where corpus_key is the unique identifier for the corpus.

The response includes details such as the corpus ID, key, name, description, enabled status, encoder information, filter attributes, custom dimensions, and usage limits.

Get the number of documents or document parts in a corpus​

Tracking the usage of documents in a corpus enables adminstrators to manage resource allocation efficiently. Monitoring corpus metrics also helps data usage stay within allocated quotas and identify trends in document growth and document segmentation.

The limit object in the response provides comprehensive information about the current usage and limits of a corpus:

  • used_docs - The number of documents currently stored in the corpus.
  • used_parts - The number of document parts contained in the corpus, which is useful in cases where documents are segmented into smaller parts.
  • used_characters - The total character count in the corpus, including all content and metadata.
  • max_metadata_bytes - The maximum allowed size for metadata per document, in bytes.

REST 2.0 URL​

Get Corpus REST Endpoint Address​

Vectara exposes a REST endpoint at the following URL to get information about the corpus:
https://api.vectara.io/v2/corpora/:corpus_key

The API Reference shows the full Get Corpus REST definition.

gRPC Example​

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