Create Corpus

POST

/v2/api/corpus

Enables authenticated users to create a new corpus within the system for organizing and managing related documents. A corpus acts as a logical container for grouping documents based on projects, topics, making it easier to manage content at scale.

What is a Corpus?

A corpus is a collection of related documents grouped together for easy access, management, and processing.

Key Fields:

name: A required field representing the title of the corpus. It should be descriptive and unique within the user’s context.

description: An optional field for providing additional context about the corpus’s purpose or content.

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/corpus' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Testing",
    "description": "This corpus is for testing purposes"
}'

Response Example

{
    "id": 484,
    "indexing_mode": {
        "id": 1,
        "mode": "exhaustive"
    },
    "created_by": "admin.ai",
    "created_on": "2024-08-30T15:31:55.369957Z",
    "modified_by": "",
    "modified_on": "2024-08-30T15:31:55.369973Z",
    "name": "Testing",
    "description": "This corpus is for testing purposes",
    "is_public": false,
    "is_deleted": false,
    "owner": 1,
    "org": 1
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Corpus created successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Trigger a refresh(reindex) of a Document

Get All Corpus