Get All Documents From Corpus

GET

/v2/api/corpus/{corpus_id}/document

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.

What is a Corpus?

A corpus is a structured collection of documents or data grouped under a specific context or use case. It is commonly used for organizing content intended for search, training, redaction, or analysis.

How to View Your Corpus ID?

To find your Corpus ID, visit the View Corpus ID Guide.

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/0/document' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

[
    {
        "id": 18998,
        "user": {
            "id": 160,
            "email": "user@example.com",
            "first_name": "John",
            "last_name": "Doe",
            "organization": 1
        },
        "created_by": "user@example.com",
        "created_on": "2025-01-07T19:54:44.656134Z",
        "type": "text",
        "source": "document.txt",
        "text": "Sample text content",
        "tags": [
            "example_tag"
        ],
        "is_deleted": false,
        "upload_from": "web",
        "step": "completed",
        "is_failed": false,
        "pages": -1,
        "corpus": 1352
    }
]

Request

Path Params

Header Params

Responses

🟢200OK

application/json

A list of documents from the specified corpus.

Headers

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Create Document In Corpus

Delete Document(s) from Corpus

Get All Documents From Corpus

How to View Your Corpus ID?#

Request

Responses

How to View Your Corpus ID?