Get all Documents for a Corpus

GET

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

Corporav2

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.

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

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"
                ],
                "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,
                "corpus": 0
            }
        ]
    }
}

Request

Path Params

corpus_id

integer

required

Corpus ID

Query Params

items_per_page

integer

optional

In case of paginated response, the number of items per page

name

string

optional

In case of filtering by name, the name of the document

paginated

boolean

optional

Specify if the response should be paginated

type

string

optional

In case of filtering by type, the type of the document

Responses

🟢200OK

application/json

Success

Body

success

boolean

optional

Default:

true

message

string

optional

Default:

Documents retrieved successfully

data

object (CorpusDocumentListGetResponseSerializer_V2)

required

count

integer

optional

num_pages

integer

optional

current_page

integer

optional

documents

array[object (CorpusDocumentListGet_DocumentCustomSerializer_V2) {16}]

required

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Get Conversation Starters for a Corpus

Upload a Document to a Corpus