Get all Documents for a Corpus

GET

/api/v2/corpora/{corpus_id}/documents

Retrieves a comprehensive list of all documents associated with a specified corpus. This endpoint is designed for authenticated users who need visibility into the contents of a particular corpus, including document metadata and processing information.

Purpose:

Allows users to fetch metadata about each document uploaded to a given corpus.

Helps in reviewing, auditing, or managing the corpus content effectively.

Path Parameters:

corpus_id (int): Corpus ID

Query Parameters:

name (str): Document name. Optional.

type (str): Document type. Optional.

paginated (bool): Paginated. Optional. Default is False.

page (int): Page number. Optional. Default is 1.

items_per_page (int): Items per page. Optional. Default is 25.

Returns

A JSON Response containing the documents for the corpus

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Documents retrieved successfully",
    "data": {
        "count": 0,
        "num_pages": 0,
        "current_page": 0,
        "documents": [
            {
                "id": 0,
                "user": {
                    "id": 0,
                    "email": "user@example.com",
                    "first_name": "string",
                    "last_name": "string",
                    "organization": 0
                },
                "tags": [
                    "string"
                ],
                "sharepoint_folder_name": "string",
                "sharepoint_drive_name": "string",
                "sharepoint_site_name": "string",
                "sharepoint_tenant_name": "string",
                "sharepoint_sync_enabled": true,
                "sharepoint_status": "string",
                "created_by": "string",
                "created_on": "2019-08-24T14:15:22Z",
                "modified_on": "2019-08-24T14:15:22Z",
                "type": "file",
                "source": "string",
                "text": "string",
                "description": "string",
                "is_deleted": true,
                "upload_from": "string",
                "step": "pending",
                "is_failed": true,
                "pages": -2147483648,
                "etag": "string",
                "corpus": 0
            }
        ]
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Get Conversation Starters for a Corpus

Upload a Document to a Corpus