Retrieve metadata about a corpus
GET/v2/corpora/:corpus_key
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 operation does not search the corpus contents. Specify the corpus_key to identify the corpus whose metadata you want to retrieve.
This endpoint 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 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 including the number of stored documents, document parts, and character count.
Request
Responses
- 200
- 403
- 404
The response includes details such as the corpus ID, key, name, description, enabled status, encoder information, filter attributes, custom dimensions, and usage limits.
Permissions do not allow retrieving the corpus.
Corpus not found.