List corpora
GEThttps://api.vectara.io/v2/corpora
List corpora in the account. The returned corpus objects contain less detail compared to those retrieved the direct corpus retrieval operation.
Request
Query Parameters
Possible values: >= 1
and <= 100
Default value: 10
The maximum number of corpora to return at one time.
A regular expression to filter the corpora by their name or summary.
Used to retrieve the next page of corpora after the limit has been reached.
Header Parameters
Possible values: >= 1
The API will make a best effort to complete the request in the specified seconds or time out.
Possible values: >= 1
The API will make a best effort to complete the request in the specified milliseconds or time out.
Responses
- 200
- 403
List of corpora.
- application/json
- Schema
- Example (from schema)
Schema
corpora object[]
metadata object
{
"corpora": [
{
"id": "string",
"key": "my-corpus",
"name": "string",
"description": "string",
"enabled": true,
"chat_history_corpus": true,
"queries_are_answers": false,
"documents_are_questions": false,
"encoder_name": "boomerang-2023-q3",
"save_history": true,
"filter_attributes": [
{
"name": "Title",
"level": "document",
"description": "The title of the document.",
"indexed": true,
"type": "text"
}
],
"custom_dimensions": [
{
"name": "importance",
"description": "Product importance.",
"indexing_default": 0,
"querying_default": 0
}
],
"limits": {
"used_docs": 0,
"used_parts": 0,
"used_bytes": 0,
"used_characters": 0,
"max_bytes": 0,
"max_metadata_bytes": 0,
"index_rate": 0
},
"created_at": "2025-03-13T21:10:44.185Z"
}
],
"metadata": {
"page_key": "string"
}
}
Permissions do not allow listing corpora.
- application/json
- Schema
- Example (from schema)
Schema
The messages describing why the error occurred.
The ID of the request that can be used to help Vectara support debug what went wrong.
{
"messages": [
"Internal server error."
],
"request_id": "string"
}
Authorization: x-api-key
name: x-api-keytype: apiKeyin: header
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://api.vectara.io/v2/corpora' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>'