Ejento APIs
Stable
  • Stable
  • V2
  • V2 Legacy
    Ejento APIs
    Stable
    • Stable
    • V2
    • V2 Legacy
    • Overview
    • Changelog
    • Versioning
    • Build an App with Ejento APIs
    • Guides
      • Response API Migration
      • Indexing API Migration
    • Authentication
      • Getting Started with Authentication
      • Authenticate User
      • Request Passwordless Exchange Token
      • Exchange Passwordless Token for Access Tokens
      • Register User
      • Update Own Password
      • Refresh Access Token
    • 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 Chat Threads
        • Get Chat Threads of an Agent
        • Create Chat Thread for an Agent
      • 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-Corpus Connections
      • Delete Agent-Corpus Connections
      • Get Agent-Corpus Connection Details
      • Create Agent-Corpus Connection
      • Update Agent-Corpus Connection
      • Delete Agent-Corpus Connection
      • Get agent history with pagination
      • Restore an agent to a previous checkpoint
      • Create Custom Instructions for an Agent
      • Get Agent Prompt History
      • Create a Recent Agent
      • Delete a Recent Agent
      • Get Agent Details with Starred Status
      • Create Starred Agent
      • Delete Starred Agent
      • Get the Status of an Agent
      • Get User's Team Role for an Agent
      • 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
      • Get an Agent Response
      • Generate Agent Response (Non-Streaming)
      • Update an Agent Response
      • Stream Agent Response (SSE)
      • Delete an Agent Response
      • Get Comments for Agent Response
      • Create a Comment for Agent Response
      • Create a Feedback for an Agent Response
      • Pin an Agent Response
      • Unpin an Agent Response
      • Get Supporting Content of an Agent Response
      • Get Thoughts of an Agent Response
      • Get Agent Responses based on filters
      • Get Agent Responses of an Agent
      • Create Agent Response Log
      • Get Pinned Agent Responses
    • 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
    • Chat Logs
      • Get Chat Log Details
      • Get Chat Log Search Results
    • Conversation Starters
      • Get Conversation Starters for an Agent
      • Create a new Conversation Starter.
    • 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
      • Remove User from Team
      • Update User Role in Team
      • Get Recent Teams
      • Get all Teams of the Authenticated User
      • Get all Agents of User's Team
    • 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 all Workflows for a Project
      • Get multiple Projects by their IDs
      • Get Projects based on filters
      • Get Recent Projects for a User
      • Get Projects with Team Details
    • Corpora
      • Get all Corpus
      • Upload a Document to a 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
      • 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
      • Trigger a Refresh (Reindex) of a Corpus
      • Get Corpora with Refresh (Reindex) Enabled
    • Documents
      • Get a Document
      • Update a Document
      • Delete a Document
      • Annotate a Document
      • Get Conversation Starters for a Document
      • Trigger a Refresh (Reindex) of a Document
      • Retrieve multiple Documents by IDs
    • Organizations
      • Get all Configurations
      • Get active configuration for an Organization
      • Get the Model Deployment for an Organization
      • 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
    • Users
      • Get a User
      • Update a User
      • Delete a User
      • Get Agent Responses of a User
      • Get all User Permissions
      • Create a new User Organization Permission
      • Update the Organization Permission of a User
      • Delete a User Organization Permission
      • Get Projects of a User
      • Get all Workflow Tables for a User
      • Get all Workflows for a User
      • Delete multiple Users
      • Get a specific User by user_email
      • Get all Users
      • Get authenticated User
      • Get User Projects
    • 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
    • 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
    • Guardrails
      • Get available guardrail types for agent
      • Apply Guardrails on Input Text
      • 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
    • Feature Flags
      • Get All Feature Flags
      • Get Agent Alias Feature Flag
      • Get Api Tools Feature Flag
      • Get Caching 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 Connector Feature Flag
      • Get Sharepoint Index Feature Flag
      • Get Youtube Index Feature Flag
    • Notifications
      • Get all Notifications
      • Create a new Notification
      • Update Notifications by User ID
      • Get a Notification
      • Update a Notification
      • Delete a Notification
    • Tools
      • Get Tool by ID
      • Update Tool by ID
      • Delete Tool by ID
    • Workflows
      • Get all Workflows
      • Create a Workflow
      • Get a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Get all Workflow Chat Threads
      • Create a Workflow Chat Thread
      • Create a Workflow Chat Response
      • Get a Workflow Chat Thread
      • Update a Workflow Chat Thread
      • Delete a Workflow Chat Thread
      • Get all Workflow Chat Responses
      • Delete a Workflow Response
      • Create a Workflow Feedback
      • Retrieve a list of reviews for a given workflow response
      • Create a Workflow Review

    Agents

    Agent Access
    Agent Alias
    Agent Tags
    Agent Chat Threads
    Agent Comment
    Agent Rating
    Agent Review
    Agent Tools
    Agent User
    Agent User Permission
    Agent Vote
    Agent Type
    Get all Agents
    GET/api/v2/agents/
    Retrieves a list of agents with support for pagination and advanced filters, enabling users to explore and manage agents effectively. Purpose: Allows...
    Create a new Agent
    POST/api/v2/agents/
    Creates a new agent along with its default associated corpus, tools, and configurations. Purpose: Initializes a new agent and sets up required linked...
    Get an Agent
    GET/api/v2/agents/{agent_id}
    Retrieves a specific agent by ID, including access control and organization-level visibility checks. Purpose: Allows users to fetch detailed informat...
    Update an Agent
    PUT/api/v2/agents/{agent_id}
    Updates an existing agent's information, including its associated corpus, tools, and configurations. Purpose: Enables users to modify an agent’s ...
    Delete an Agent
    DELETE/api/v2/agents/{agent_id}
    Soft-deletes an agent and marks its associated resources as deleted, without permanently removing them from the database. Purpose: Allows users to de...
    Activate an Agent
    PUT/api/v2/agents/{agent_id}/activate
    Activates a specific agent. Purpose: Enables users to activate an agent for use in the application. Path Parameters: agent_id (int): Unique identif...
    Get Agent-Corpus Connections
    GET/api/v2/agents/{agent_id}/corpora
    Allows retrieving agent-corpus connections filtered by agent id. This endpoint supports pagination and filtering options. Query Parameters: is_enable...
    Delete Agent-Corpus Connections
    DELETE/api/v2/agents/{agent_id}/corpora
    Allows deleting agent-corpus connections filtered by agent id. Default corpus cannot be deleted. Returns: A Response with the confirmation message or...
    Get Agent-Corpus Connection Details
    GET/api/v2/agents/{agent_id}/corpora/{corpus_id}
    Allows retrieving agent-corpus connection details. Query Parameters: is_enabled: To filter connections based on enabled status. verbosity: To determi...
    Create Agent-Corpus Connection
    POST/api/v2/agents/{agent_id}/corpora/{corpus_id}
    Allows creating a new agent-corpus connection. Returns: A Response with the created agent-corpus connection or error message. Current Version: 2.0....
    Update Agent-Corpus Connection
    PUT/api/v2/agents/{agent_id}/corpora/{corpus_id}
    Allows updating the enabled status of an agent-corpus connection. Request Body: is_enabled (bool): The new enabled status of the agent-corpus connect...
    Delete Agent-Corpus Connection
    DELETE/api/v2/agents/{agent_id}/corpora/{corpus_id}
    Allows deleting an agent-corpus connection. Returns: A Response with the confirmation or error message. Current Version: 2.0.0
    Get agent history with pagination
    GET/api/v2/agents/{agent_id}/history
    Get the history of an agent. Query Parameters: page (int): Page number for pagination (default: 1) items_per_page (int): Number of items per pag...
    Restore an agent to a previous checkpoint
    PUT/api/v2/agents/{agent_id}/history
    Restore an agent to a previous checkpoint. Request Body: history_id (int): ID of the history record to restore
    Create Custom Instructions for an Agent
    POST/api/v2/agents/{agent_id}/instructions
    Creates custom instructions for an agent. Request Body: custom_instructions (list): A list of custom instructions to create. Returns: A JSON respon...
    Get Agent Prompt History
    GET/api/v2/agents/{agent_id}/prompt-histories
    Retrieves the prompt history for a specific agent. Purpose: Enables users to view the prompt history for a specific agent. Path Parameters: agent_i...
    Create a Recent Agent
    POST/api/v2/agents/{agent_id}/recents
    Creates a new recent agent. Parameters: agent_id (int): The ID of the agent to create a new recent agent for. Returns: A JSON response with the ser...
    Delete a Recent Agent
    DELETE/api/v2/agents/{agent_id}/recents
    Deletes a recent agent. Removes the agent from the user's recent agents list. Purpose: Enables users to delete a recent agent. Path Parameters: ...
    Get Agent Details with Starred Status
    GET/api/v2/agents/{agent_id}/starred
    Retrieves an agent's details along with whether it is starred by the user. Purpose: Enables users to see starred status of an agent. Path Parame...
    Create Starred Agent
    POST/api/v2/agents/{agent_id}/starred
    Creates a new starred agent. Purpose: Enables users to create a new starred agent. Path Parameters: agent_id (int): ID of the agent to be starred. ...
    Delete Starred Agent
    DELETE/api/v2/agents/{agent_id}/starred
    Deletes a specific starred agent. Purpose: Enables users to delete a specific starred agent. Path Parameters: agent_id: ID of the agent to be delet...
    Get the Status of an Agent
    GET/api/v2/agents/{agent_id}/status
    Retrieves the current status of a specific agent. Purpose: Enables clients to check the operational or publication status of an agent for monitoring,...
    Get User's Team Role for an Agent
    GET/api/v2/agents/{agent_id}/team-role
    Fetches the role of the current user in the team of the given agent. Path Parameters: agent_id: ID of the agent. Returns: A JSON response with the ...
    Get Agent Filter
    GET/api/v2/agents/filter
    Fetches agents based on date range, project IDs, and user interaction filters. Query Parameters: start_date: ISO format date (optional, defaults to 3...
    Generate an image for an agent based on the provided description
    POST/api/v2/agents/image
    Generate an image for an agent based on the provided description Returns: A JSON object containing the generated image URL
    Get all Agents by Project
    GET/api/v2/agents/projects/{project_id}
    Retrieves all agents by project and by page. Purpose: Enables users to fetch all agents by project and by page. Path Parameters: project_id (int): ...
    Get list of Recent Agents
    GET/api/v2/agents/recents
    Retrieves the list of recent agents of the user. Purpose: Enables users to view the list of recent agents. Returns: A JSON response with the serial...
    Get all Starred Agents of the Authenticated User
    GET/api/v2/agents/starred
    Retrieves a list of starred agents for the current user. Purpose: Enables users to view their list of starred agents. Returns: A JSON response with...
    Get Agents accessible to the Current User across their Teams
    GET/api/v2/agents/teams
    Fetches Agents accessible to the Current User across their Teams, optionally filtered by name and paginated. Purpose: Enables users to view all Agent...
    Get Agents by Project team, User team
    GET/api/v2/agents/teams/{team_id}
    Fetches Agents by Project team, User team and searches within the User team. Purpose: Enables users to view Agents by Project team, User team and sea...
    Previous
    Refresh Access Token
    Next
    Agent Access
    Built with