Get All Corpus

GET

/v2/api/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.

What is a Corpus?

A corpus is a structured collection of documents grouped under a common context or project. It acts as a container for related content to be processed, searched, or analyzed together.

For more detailed information about corpus, refer to the Corpus Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/corpus' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

[
    {
        "id": 123,
        "indexing_mode": {
            "id": 1,
            "mode": "exhaustive"
        },
        "name": "Sample Corpus",
        "description": "A sample corpus for testing.",
        "owner": {
            "id": 16,
            "email": "user@example.com",
            "is_superuser": true,
            "first_name": "John",
            "last_name": "Doe",
            "organization": {
                "id": 1,
                "org_name": "Example Organization"
            }
        },
        "tags": []
    }
]

Request

Header Params

Responses

🟢200OK

application/json

List of all corpus entries retrieved successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Create Corpus

Get Corpus