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.

Request Body:

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

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

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

Returns:

A response with the corpora data

Current Version:

2.0.0

{ "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": "user@example.com", "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" } ] } }

Request

Responses