Get all Corpus

Allows authenticated users to retrieve a comprehensive list of all corpus entries avaiable.
This endpoint serves as a centralized overview, enabling users to view metadata, ownership, indexing mode, and organizational details for each corpus.

Purpose:

Provides users with visibility into all corpora they have access to, whether created by them or shared within their organization.

Supports content discovery and management by displaying corpus-level metadata and ownership information.

Query Parameters:

corpus_type (str): The type of corpus to filter by. Valid values: "document", "structured", "attachment". Default: "document"

name (str): The name of the corpus to filter by

owner (str): The email address(es) of the corpus owner(s) to filter by. Can pass comma separated values.

indexing_mode (str): The indexing mode of the corpus to filter by. Valid values: "basic", "moderate", "exhaustive". Default: None. Can pass comma separated values.

paginated (bool): Whether to paginate the response

page (int): The page number to return

items_per_page (int): The number of items per page

verbosity (str): The verbosity level of the response

sort_by (str): The field to order the results by. Default is "-modified_on". Possible values are "name", "indexing_mode", "created_on", "modified_on", "owner_email". Add "-" before the field name to order in descending order.

query (str): The query to filter the results by. Search is done on name, owner email.

Request Headers:

X-Authorization-Consistency-Token (string, optional): Authorization consistency token for read-after-write consistency. Pass the token received from a previous write operation to ensure this read reflects that write.

Returns:

A response with the corpora data

Change Log:

2.1.0: Added standard pagination. Added "items, meta" to response. Deprecated "corpora" from the response.

2.0.0: Initial version

curl --location --globoff 'https:///api/v2/corpora/?corpus_type=undefined&indexing_mode=undefined&items_per_page=undefined&name=undefined&owner=undefined&page=undefined&paginated=undefined&query=undefined&sort_by=undefined&verbosity=undefined' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer '

{ "success": true, "message": "string", "data": { "count": 0, "num_pages": 0, "current_page": 0, "corpora": [ { "id": 0, "name": "string", "description": "string", "indexing_mode": { "id": 0, "mode": "exhaustive" }, "owner": { "id": 0, "email": "[email protected]", "is_superuser": true, "first_name": "string", "last_name": "string", "organization": { "id": 0, "org_name": "string" } }, "tags": [ "string" ], "refresh_schedule": { "frequency": "string", "month": "string", "date": 0, "time": "string", "day": "string" }, "refresh_type": "string", "is_default": true, "created_on": "2019-08-24T14:15:22.123Z", "modified_on": "2019-08-24T14:15:22.123Z" } ], "items": [ {} ], "meta": { "count": 0, "num_pages": 0, "current_page": 0 } } }

Request

Responses