Ejento APIs
V1
  • V2
  • V1
    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
        • Create Corpus
        • Get Corpus by ID
        • Edit Corpus
        • Delete Corpus
        • Get Corpus Permissions
        • Create Corpus Permissions
        • Delete Corpus Permissions
        • Get Corpus Permission By User
        • Create Document In Corpus
        • Get All Documents From Corpus
        • Delete All Documents
        • Check Duplicate Documents
      • 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

    Overview

    API Overview – Version 1 (v1)#

    This documentation allows you to explore and test all available APIs for the Ejento platform. Using the APIs, you can integrate Ejento’s capabilities into your own applications.

    Getting Started#

    Create Your API Key:#

    First, head over to the Developer Portal to create your API key. You will need this key to authenticate and interact with the Ejento APIs.
    Once you've generated your key, make sure to keep it secure and include it in your requests.

    Navigating the Documentation:#

    On the sidebar, you’ll find a list of available API endpoints grouped by functionality. Click on any section to expand it and view details for each API.
    Each API page provides information such as the endpoint URL, request parameters, example responses, and error codes.

    Using the API Playground:#

    Once you have your API key, you can use the Playground available within this documentation to test any API in real-time.
    Each API page includes a Try It Out section where you can input your API key, set parameters, and submit requests directly from your browser.
    View the responses to see how the API behaves, or troubleshoot any issues with your implementation.
    Next
    Run Chat