Ejento APIs
V2
  • V2
  • V1
  1. Documents
Ejento APIs
V2
  • V2
  • V1
  • Overview
  • Changelog
  • Versioning
  • Legacy
    • Introduction to Legacy APIs
    • Agent
      • Create Agent By Agent Builder
      • Create Agent By Configure
      • Get All Agents
      • Get Agent By Team
      • Get Agent By User Team
      • Agent Filtered
      • Get Agent
      • Edit Agent
      • Get Recent Agents
      • Create Recent Agent
      • Delete Recent Agent
      • Get Starred Agents
      • Create Starred Agent
      • Delete Starred Agent
    • Agent Corpus Connection
      • Create Agent Corpus Connection
      • Get Agent Corpus Connection
      • Edit Agent Corpus Connection
      • Delete Agent Corpus Connection
      • Get All Agent Corpus Connections
      • Delete All Agent Corpus Connections
    • Agent Response
      • Create Agent Response
      • Get All Agent Responses
      • Get Agent Responses By User
      • Get Agent Responses By Project
      • Get Agent Responses By Chat Thread
      • Get Agent Response
      • Delete Agent Response
      • Create Agent Response Comment
      • Get Agent Response Comment
      • Get Agent Response Dashboard
      • Create Agent Response Feedback
      • Create Agent Response Log
      • Pin Agent Response
      • Unpin Agent Response
      • Get Pinned Agent Responses
    • Agent Reviews
      • Create Review
      • Get All Reviews
      • Get Reviews by Agent
      • Delete Review
    • Agent Rating
      • Get All Agent Ratings
      • Get Agent Rating
      • Update Agent Rating
    • Agent Alias
      • Get All Agent Aliases
      • Create Agent Alias
      • Update Agent Alias
      • Delete Agent Alias
    • Agent Access
      • Get Agent Access
      • Update Agent Access
    • Agent Type
      • Get All Agent Types
      • Get Agent Type
      • Update Agent Type
    • Agent User
      • Add Users to Agent
      • Get Users Of Agent
      • Delete User from Agent
      • Get User Agent Permission
      • Get All Agents with Users
    • Agent Tags
      • Get All Distinct Agent Tags
      • Annotate an Agent with Tags
    • Agent Vote
      • Create Agent Vote
      • Get Agent Vote
    • Agent Comment
      • Create Comment on an Agent
      • Get Comments for an Agent
      • Edit Agent Comment
    • Chat Thread
      • Create Chat Thread
      • Get All Chat Threads Of An Agent
      • Get All Chat Threads With Admin Panel Filters And Pagination
      • Get Reduced Chatlogs by Thread ID for Admin Panel
      • Get Chat Thread
      • Edit Chat Thread
      • Delete Chat Thread
      • Add ChatThread-Corpus Connection
      • Get ChatThread-Corpus Connection
      • Delete ChatThread-Corpus Connection
    • Project
      • Create Project
      • Get All Projects
      • Project Filtered
      • Get All Agents Of Project
      • Get All Projects By Team
      • Get Project
      • Edit Project
      • Delete Project
      • Fetch Project Details
      • Add Recent Project
      • Get Recent Projects
    • User Project
      • Add Users To Project
      • Get All Projects By User Teams
      • Get Projects By User and Team
      • Delete Users from Project
    • Document
      • Get Document
      • Edit Document
      • Add Or Remove Tags On Document
      • Document Polling
    • Corpus
      • Create Corpus
      • Get All Corpus
      • Get Corpus
      • Edit Corpus
      • Delete Corpus
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete All Documents from Corpus
      • Check Duplicate Documents
      • Get All Agents By Corpus
      • Get Corpus Permissions
      • Get Corpus Permission By User
      • Annotate Corpus
    • Notification
      • Create Notification
      • Retrieve All Notifications
      • Read Notifications By User ID
      • Retrieve Notification
      • Read Notification
      • Delete Notification
    • Feature Flag
      • Get All Feature Flags
      • Get DALL-E Feature Flag
      • Get Share Agent Feature Flag
      • Get Agent Alias Feature Flag
      • Get SharePoint Index Feature Flag
      • Get Chat Agent Creation Feature Flag
      • Get OAuth Feature Flags
      • Get Google OAuth Feature Flag
      • Get LinkedIn OAuth Feature Flag
      • Get MS SSO OAuth Feature Flag
      • Get Github OAuth Feature Flag
    • Team
      • Create Team
      • Get All Teams
      • Get Team Details
      • Edit Team
      • Delete Team
      • Create Recent Team
      • Get Recent Teams
      • Add Users to Team
      • Get Users in a Team
      • Get Teams Of User
      • Get User Role By Team
      • Get Agents Of User Team
      • Get Projects And Team
    • User
      • Create User In Organization
      • Get All Users By Organization
      • Get User
      • Edit User
      • Delete User
      • Batch Delete Users
      • User Filtered
      • Create User Permission
      • Get User Permission
      • Edit User Permission
      • Delete User Permission
    • Email Indexing Authorization
      • Email Authorize
    • Conversation Starters
      • Create Conversation Starter
      • Get Conversation Starters
    • Tool
      • Create Tool
      • Get All Tools
      • Get Tool
      • Edit Tool
      • Delete Tool
    • Agent Tool Connection
      • Enable Agent Tool
      • Get All Agent Tools
      • Disable Agent Tool
    • Organization Tool
      • Enable Organization Tool
    • API Tool Template
      • Create API Tool Template
      • Get All API Tool Templates
    • LLM Config
      • Get All LLM Configs
      • Get Active Config
      • Get LLM Config
      • Get Model Deployment
      • Get Org Configs
      • Set Agent Config View
  • Latest
    • Introduction to Latest APIs
    • Agents
      • Agent Access
        • Get Agent Access
        • Update Agent Access
      • Agent Alias
        • Get Agent Alias
        • Create an Agent Alias
        • Update an Agent Alias
        • Delete an Agent Alias
        • Get all Agent Aliases
      • Agent Tags
        • Add or Remove Tags from an Agent
        • Get all Tags for a given Project, Team, or Organization
        • Get all Tags grouped by Agent for a given Project, Team, or Organization
      • Agent Comment
        • Get all Comments for an Agent
        • Create a Comment
        • Update a Comment
        • Delete a Comment
      • Agent Rating
        • Get Ratings of an Agent
        • Update Agent Rating
        • Get all Agent Ratings
      • Agent Review
        • Get all Reviews for specific Agent
        • Create a new Review
        • Get all Reviews of the Authenticated User
        • Update a Review
        • Delete a Review
      • Agent Tools
        • List all Tools with their enabled status for the given Agent
        • Unlink an Agent from a Tool
        • Link an Agent to a Tool
        • List all tools that are connected to the Agent
      • Agent User
        • Get Users of an Agent
        • Add user to Agent
        • Delete User from Agent
        • Get all Agents Users
      • Agent User Permission
        • Get User Agent Permission
      • Agent Vote
        • Get Vote Information for an Agent
        • Vote on an Agent
      • Agent Type
        • Get all Agent Types
        • Get a specific Agent Type
        • Update a specific Agent Type
      • Get all Agents
      • Create a new Agent
      • Get an Agent
      • Update an Agent
      • Delete an Agent
      • Activate an Agent
      • Get agent history with pagination
      • Restore an agent to a previous checkpoint
      • Get Agent Prompt History
      • Create a Recent Agent
      • Delete a Recent Agent
      • Create Starred Agent
      • Delete Starred Agent
      • Get the Status of an Agent
      • Get User's Team Role for an Agent
      • Create or Update an Agent using the Agent Builder
      • Get Agent Filter
      • Generate an image for an agent based on the provided description
      • Get all Agents by Project
      • Get list of Recent Agents
      • Get all Starred Agents of the Authenticated User
      • Get Agents accessible to the Current User across their Teams
      • Get Agents by Project team, User team
    • Agent Response Steps
      • List Steps for Agent Response
      • Create Step for Agent Response
      • Delete All Steps for Agent Response
      • Retrieve a Step for Agent Response
      • Update a Step for Agent Response
      • Delete a Step for Agent Response
    • Corpora
      • Get all Corpus
      • Create a Corpus
      • Get a Corpus
      • Update a Corpus
      • Delete a Corpus
      • Get Corpus Agent Connections
      • Get Default Corpus Agent Connection
      • Annotate/Tag a Corpus
      • Get Conversation Starters for a Corpus
      • Get all Documents for a Corpus
      • Upload a Document to a Corpus
      • Delete Document(s) from a Corpus
      • Check Duplicate Documents in a Corpus
      • Get all Permissions for a Corpus
      • Create a new Permission for a Corpus
      • Delete a user permission for a corpus
      • Get all user permissions for a corpus
    • Documents
      • Get a Document
        GET
      • Update a Document
        PUT
      • Delete a Document
        DELETE
      • Annotate a Document
        POST
      • Retrieve multiple Documents by IDs
        POST
    • Chat Logs
      • Get Chat Log Details
      • Get Chat Log Search Results
    • Chat Thread
      • Agent Response
        • Get Agent Responses for a Chat Thread
        • Delete Agent Responses for a Chat Thread
      • Chat Logs
        • Get Chat Logs for a Chat Thread
      • Corpus Connection
        • Get Corpus Connection by ChatThread ID
        • Delete Corpus Connection by ChatThread ID
        • Get a ChatThread-Corpus connection
        • Create a ChatThread-Corpus connection
        • Delete a ChatThread-Corpus connection
      • Documents
        • Get Documents in Chat Thread
      • Get Chat Thread
      • Update Chat Thread
      • Delete Chat Thread
      • Get Chat Threads based on various filters
    • Configurations
      • Update the LLM configuration for an Agent
      • Get OAuth-related Feature Flags
    • Evaluations
      • Retrieve all evaluations or filter by dataset
      • Create a new evaluation
      • Delete a set of evaluations or a specific evaluation
      • Retrieve all evaluation datasets for a specific agent
      • Create a new evaluation dataset for the given agent
      • Delete multiple datasets or all datasets for an agent
      • Retrieve a specific evaluation
      • Update an evaluation run
      • Delete a specific evaluation
      • List query results for an evaluation run
      • Create a query result and save metrics
      • Retrieve a specific dataset
      • Update an evaluation dataset
      • Delete a specific dataset
      • Retrieve queries for an evaluation dataset
      • Create a new query for evaluation
      • Retrieve all unique tags from all datasets in the organization
      • Get a specific metric result by ID
      • Retrieve all metrics or filter by category name
      • Create a new metric
      • Retrieve a specific metric
      • Update a metric
      • Delete a metric
      • Get all metric results for a specific metric
      • Create a new metric result entry for the given metric
      • Retrieve a specific evaluation query
      • Update an evaluation query
      • Delete an evaluation query
      • Get a specific query result with metrics
      • Update a query result
    • SharePoint
      • Get SharePoint Item By Full Path
      • Get SharePoint Item
      • Create a SharePoint Item
      • Update a SharePoint Item
      • Delete SharePoint Hierarchy Item
    • SharePoint Connector
      • Get Corpus IDs by SharePoint Drive ID
      • Get SharePoint URLs by Corpus ID
      • Get SharePoint Drive Mappings
      • Create or Update SharePoint Drive Mapping
      • Update SharePoint Drive Mapping Token or Subscription
      • Get SharePoint Drive Token Information
      • Get All SharePoint Subscriptions
    • Guardrails
      • Get available guardrail types for agent
      • Enable/disable a guardrail type for agent
      • Get Guardrails
      • Update Guardrails
      • Delete Guardrails
      • Get Guardrails in Organization
      • Create Guardrail in Organization
      • Enable or Disable Guardrail for Organization
    • Conversation Starters
      • Get Conversation Starters for an Agent
      • Create a new Conversation Starter.
    • Analytics
      • Get Agent Cost Data
      • Get Agent Document Count Data
      • Get Agent Indexing Mode Data
      • Get Agent Most Active Data
      • Get Agent Query Count Data
      • Get Recent Agent Data
      • Get Agent Summary Statistics
      • Get Agent Token Data
      • Get Agent Vote Data
      • Get Corpus Document Count Data
      • Get Corpus Indexing Mode Data
      • Get Cost Data
      • Get Document Count Data
      • Get Indexing Mode Data
      • Get Project Cost Data
      • Get Project Document Count Data
      • Get Project Indexing Mode Data
      • Get Project Most Active Data
      • Get Project Query Count Data
      • Get Recent Project Data
      • Get Project Summary Statistics
      • Get Project Token Data
      • Get Project Vote Data
      • Get Overall Summary Statistics
      • Get Team Cost Data
      • Get Team Document Count Data
      • Get Team Indexing Mode Data
      • Get Team Most Active Data
      • Get Team Query Count Data
      • Get Recent Team Data
      • Get Team Summary Statistics
      • Get Team Token Data
      • Get Team Vote Data
      • Get Total Entity Counts
      • Get User Cost Data
      • Get User Document Count Data
      • Get User Indexing Mode Data
      • Get User Most Active Data
      • Get User Query Count Data
      • Get Recent User Data
      • Get User Summary Statistics
      • Get User Token Data
      • Get User Vote Data
      • Get Vote Count Data
      • Get Query Count Data
      • Get Token Data
    • Teammates
      • Get All Active Carousels
      • Create Carousel
    • Tools
      • Get Tool by ID
      • Update Tool by ID
      • Delete Tool by ID
      • Get all Tools
    • Feature Flags
      • Get All Feature Flags
      • Get Agent Alias Feature Flag
      • Get Api Tools Feature Flag
      • Get Chat Agent Creation Feature Flag
      • Get dall_e Image Generation Feature Flag
      • Get Developer Portal Feature Flag
      • Get Guardrail Feature Flag
      • Get PII Redaction Feature Flag
      • Get Share Agent Feature Flag
      • Get Sharepoint Index Feature Flag
      • Get Youtube Index Feature Flag
    • Users
      • Get a User
      • Update a User
      • Delete a User
      • Get all User Permissions
      • Create a new User Organization Permission
      • Update the Organization Permission of a User
      • Delete a User Organization Permission
      • Delete multiple Users
      • Get a specific User by user_email
      • Get all Users
      • Get authenticated User
    • Notifications
      • Get all Notifications
      • Create a new Notification
      • Get a Notification
      • Update a Notification
      • Delete a Notification
    • Projects
      • Retrieve all Projects
      • Create a Project
      • Get a Project
      • Update a Project
      • Delete a Project
      • Get Agent Responses using Project ID
      • Add a Recent Project for a User
      • Add Users to a Project
      • Remove a User from a Project
      • Get multiple Projects by their IDs
      • Get Projects based on filters
      • Get Recent Projects for a User
      • Get Projects with Team Details
    • Teams
      • Get all Teams
      • Create a Team
      • Get a Team
      • Update a Team
      • Delete a Team
      • Get all Projects of a Team
      • Create a Recent Team
      • Get all Users in a Team
      • Add Users to a Team
      • Get Recent Teams
      • Get all Teams of the Authenticated User
      • Get all Agents of User's Team
    • Organizations
      • Get all Configurations
      • Get active configuration for an Organization
      • Get the Model Deployment for an Organization
      • Get Organization Logo
      • Get all Tools in an Organization
      • Disable a Tool for all Agents in an Organization
      • Enable a Tool for all Agents in an Organization
      • Get all API Tool Templates
      • Create a new API Tool Template
      • Create a new API tool
      • Create an attachment tool
      • Create a new RAG tool in an Organization
      • Create a Web Search Tool in an Organization
      • Get all Users in an Organization
      • Create a User in an Organization
      • Get all Configurations of user's Organization
      • Get all LLM configurations of the user's Organization
      • Get a specific LLM configuration by ID
  1. Documents

Update a Document

PUT
/api/v2/documents/{document_id}
Documentsv2
Allows authenticated users to update the content of an existing document by specifying its unique document_id.
This endpoint is ideal for modifying or correcting the data of a document post-upload.
Purpose:
To provide users the ability to revise the document's textual content.
Ensures that document data remains accurate, up-to-date, and reflective of any necessary changes.
Path Parameters:
document_id (int): The ID of the document to update
Request Body:
step (str): The step to update the document to. [Optional]
description (str): The description of the document. [Optional]
tags (list): The tags of the document. [Optional]
source (str): The source of the document. [Optional]
access_url (str): The access URL of the document. [Optional]
text (str): The text of the document. [Optional]
Returns:
A response containing the updated document details
Current Version:
2.0.0
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/v2/documents/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "step": "string",
    "description": "string",
    "tags": [
        "string"
    ],
    "source": "string",
    "access_url": "string",
    "text": "string"
}'
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "string",
    "data": {
        "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_by": "string",
        "modified_on": "2019-08-24T14:15:22Z",
        "type": "file",
        "source": "string",
        "access_url": "string",
        "text": "string",
        "description": "string",
        "is_deleted": true,
        "upload_from": "string",
        "step": "pending",
        "is_failed": true,
        "summary_token_usage": {
            "property1": null,
            "property2": null
        },
        "keywords_question_token_usage": {
            "property1": null,
            "property2": null
        },
        "pages": -2147483648,
        "corpus": 0
    }
}

Request

Path Params
document_id
integer 
required
Document ID
Body Params application/json
step
string 
optional
description
string 
optional
tags
array[string]
optional
source
string 
optional
access_url
string 
optional
text
string 
optional
Examples

Responses

🟢200OK
application/json
Success
Body
success
boolean 
required
message
string 
required
data
object (DocumentDetailPutResponseSerializer_V2) 
required
id
integer 
read-onlyrequired
user
object (DocumentDetailPut_UserIndexSerializer_V2) 
required
tags
array[string]
optional
created_by
string 
required
<= 512 characters
created_on
string <date-time>
read-onlyrequired
modified_by
string 
required
<= 512 characters
modified_on
string <date-time>
read-onlyrequired
type
enum<string> 
required
file - File
weblink - Weblink
youtube - YouTube
text - Text
Allowed values:
fileweblinkyoutubetext
source
string  | null 
optional
access_url
string  | null 
optional
<= 1024 characters
text
string  | null 
optional
description
string  | null 
optional
is_deleted
boolean 
optional
upload_from
string  | null 
optional
<= 1024 characters
step
enum<string> 
optional
pending - Pending
queued - Queued
extracting - Extracting
uploading - Uploading
indexing - Indexing
indexed - Indexed
completed - Completed
augmenting - Augmenting
splitting - Splitting
embedding - Embedding
conversation starters - Conversation Starters
Allowed values:
pendingqueuedextractinguploadingindexingindexedcompletedaugmentingsplittingembeddingconversation starters
is_failed
boolean 
optional
summary_token_usage
object 
optional
keywords_question_token_usage
object 
optional
pages
integer 
optional
>= -2147483648<= 2147483647
corpus
integer 
required
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Previous
Get a Document
Next
Delete a Document