List Corpora API Definition

The List Corpora API lets you retrieve a list of corpora in your account. This endpoint returns a paginated list of corpora objects, which contain basic information about each corpus.

List Corpora Request and Response

To list corpora, send a GET request to /v2/corpora. You can specify optional parameters to control the pagination and filtering of the results. The limit parameter determines the maximum number of corpora to return, with a default value of 10 and a maximum value of 100.

The filter parameter also lets you specify a regular expression to filter
based on name or summary. The page_key parameter retrieves the next page of results when the previous request has reached the limit.

The response includes an array of corpora objects with matching corpora and metadata.

REST 2.0 URL

List Corpora REST Endpoint Address

Vectara exposes a REST endpoint at the following URL to list corpora in the account: https://api.vectara.io/v2/corpora

The API Reference shows the full List Corpora REST definition.

gRPC Example

You can find the full List Corpora gRPC definition at admin.proto.