v3
latestOpenAPI 3.0.02026-08-081996601.2 MBList corpora
Lists the corpora in your account. Results are paginated. Each corpus object contains basic information about the corpus. These objects contain less detail than the corpus returned by the Get Corpus API.
Optional parameters control the pagination and filtering of the results. The limit parameter sets the maximum number of corpora to return. It defaults to 10 and has a maximum value of 100.
Query parameters
The maximum number of corpora to return at one time.
A regular expression to filter the corpora by their name or summary.
Filter corpora to only include corpora with these IDs.
The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.
Headers
The platform makes a best effort to complete the request in the specified seconds, or it times out.
The platform makes a best effort to complete the request in the specified milliseconds, or it times out.
Response
The response includes an array of matching corpora objects and pagination metadata.
Example response
{
"corpora": [
{
"id": "crp_1",
"key": "my-corpus",
"name": "Vectara Content",
"description": "Description about the Vectara Content corpus.",
"encoder_name": "boomerang-2023-q3",
"filter_attributes": [
{
"name": "Title",
"level": "document",
"description": "The title of the document.",
"type": "text"
}
],
"custom_dimensions": [
{
"name": "importance",
"description": "Product importance."
}
],
"limits": {
"used_docs": 8,
"used_parts": 3748,
"used_bytes": 795790,
"used_characters": 1839847,
"max_metadata_bytes": 10485760
}
}
],
"metadata": {
"page_key": "eyJvZmZzZXQiOjF9"
}
}