Ejento APIs
V1
  • V2
  • V1
  1. Corpus APIs
Ejento APIs
V1
  • V2
  • V1
  • Overview
  • Endpoints
    • Chat APIs
      • Run Chat
      • Create Custom Instructions
      • Add Comment Feedback
      • Add Upvote Feedback
      • Add Downvote Feedback
      • Get Chat Thread
      • Get Thought Process
      • Get Supporting Content
      • Get All Agent Threads
    • Agent APIs
      • Get Recent Agents
      • Add to Recent Agents
      • Delete Recent Agent
      • Get Starred Agents
      • Delete Starred Agents
      • Get Agents by Team or User Team
      • Create a Review for an Agent
      • Get Agent Reviews
      • Update an Agent Review
      • Delete an Agent Review
      • Create Agent Chat
      • Get Agent Ratings
      • Toggle Rating
      • Create Agent Alias
      • Get All Agent Alias
      • Update Agent Alias
      • Get Agent Access Level
      • Update Agent Access Level
      • Get All Agents by Project
      • Get Agent Types
      • Update Agent Type
      • Get User Agent or User Agent Permission
    • Project APIs
      • Create New Project
      • Get All Projects
      • Get Project Details by ID
      • Edit Project By ID
      • Delete Project By ID
      • Add Recent Project
      • Get Recent Projects
      • Fetch Project Details
      • Add User to Project
      • Remove User from Project
      • Get User Projects For Team
    • Document APIs
      • Get Document By ID
      • Edit Document By ID
      • Delete Document By ID
    • Corpus APIs
      • Get All Corpus
        GET
      • Create Corpus
        POST
      • Get Corpus by ID
        GET
      • Edit Corpus
        PUT
      • Delete Corpus
        DELETE
      • Get Corpus Permissions
        GET
      • Create Corpus Permissions
        POST
      • Delete Corpus Permissions
        DELETE
      • Get Corpus Permission By User
        GET
      • Create Document In Corpus
        POST
      • Get All Documents From Corpus
        GET
      • Delete All Documents
        DELETE
      • Check Duplicate Documents
        POST
    • Evaluation APIs
      • Create Evaluation Test
      • Get All Evaluation Tests for an Agent
      • Update Evaluation Test
      • Get One Evaluation Test
      • Update Evaluation Status
      • Get Evaluation Dataset for an Agent
      • Get All Evaluation Datasets for an Agent
      • Create Evaluation Dataset
      • Update Evaluation Dataset
      • Delete Evaluation Dataset
      • Get Agent Queries
      • Get Dataset Queries
    • SharePoint APIs
      • Get SharePoint items by full path
      • Get a SharePoint item by its ID
      • Create a new SharePoint item
      • Edit SharePoint item
      • Delete a SharePoint item
    • User APIs
      • Get All Users
      • Get User By ID
      • Edit User By ID
      • Delete User by ID
      • Create User Permission
      • Get User Permission by ID
      • Edit User Permission by ID
      • Delete User Permission by ID
      • Batch Delete Users
    • Analytics APIs
      • Get Tokens by Date
      • Get Tokens by Segment
      • Get User Tokens
      • Get Agent Tokens
      • Get Team Tokens
      • Get Query Count by Date
      • Get Query Count by Segment
      • Get Total Count
      • Get Daily Chat Engagement
      • Get Weekly Chat Engagement
      • Get Monthly Chat Engagement
      • Get User Engagement
      • Get Daily Chatlog Tokens
      • Get Weekly Chatlog Tokens
      • Get Monthly Chatlog Tokens
      • Get Agent Engagement
      • Get Engagement by Team
      • Get Engagement by User
      • Get Recently Active Agents
      • Get Recent Users
    • Notification APIs
      • Send Notification To User
      • Read Notification By ID
  1. Corpus APIs

Get All Documents From Corpus

GET
/api/corpus/{corpus_id}/document/
Corpus APIs
This endpoint allows authenticated users to retrieve a list of documents from a specific corpus.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/corpus//document/'
Response Response Example
[
    {
        "id": 13212,
        "user": {
            "id": 4,
            "email": "user@example.com",
            "first_name": "example",
            "last_name": "user"
        },
        "created_by": "user@example.com",
        "created_on": "2024-08-30T15:34:01.975873Z",
        "modified_by": "user@example.com",
        "modified_on": "2024-08-30T15:34:01.975899Z",
        "type": "file",
        "source": "Dummy file1725032042.txt",
        "access_url": "string",
        "text": "string",
        "tags": [
            "string"
        ],
        "is_deleted": false,
        "upload_from": "web",
        "step": "completed",
        "is_failed": false,
        "corpus": 484
    }
]

Request

Path Params
corpus_id
integer 
required
The ID of the corpus to retrieve documents from.

Responses

🟢200OK
application/json
A list of documents from the specified corpus.
Headers
Content-Type
string 
optional
Example:
application/json
Body
array of:
id
integer 
optional
Document ID
Example:
13212
user
object 
optional
id
integer 
optional
User ID
Example:
4
email
string 
optional
User email
Example:
user@example.com
first_name
string 
optional
User first name
Example:
example
last_name
string 
optional
User last name
Example:
user
created_by
string 
optional
The creator's email.
Example:
user@example.com
created_on
string <date-time>
optional
Date and time of document creation.
Example:
2024-08-30T15:34:01.975873Z
modified_by
string 
optional
The user who last modified the document.
Example:
user@example.com
modified_on
string <date-time>
optional
Last modification timestamp.
Example:
2024-08-30T15:34:01.975899Z
type
string 
optional
Document type (e.g., file, text).
Example:
file
source
string 
optional
Name of the document.
Example:
Dummy file1725032042.txt
access_url
string  | null 
optional
URL to access the document (if available).
text
string  | null 
optional
Extracted text from the document.
tags
array[string]
optional
Tags associated with the document.
is_deleted
boolean 
optional
Indicates if the document is deleted.
Example:
false
upload_from
string 
optional
Source from where the document was uploaded (e.g., web, mobile).
Example:
web
step
string 
optional
Document processing status.
Example:
completed
is_failed
boolean 
optional
Indicates if the document processing failed.
Example:
false
corpus
integer 
optional
The ID of the corpus to which the document belongs.
Example:
484
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Previous
Create Document In Corpus
Next
Delete All Documents