ejento.ai API
Stable
  • Stable
  • V2
  • V2 Legacy
Stable
  • Stable
  • V2
  • V2 Legacy
ejento.ai
Stable
  • Stable
  • V2
  • V2 Legacy
    • Overview
    • Changelog
    • Versioning
    • Quick-Start Template for Building an App
    • FAQs
    • Guides
      • Getting Started
        • How to generate API Key and Auth Token
        • Build an App with Ejento APIs
        • How to Import Ejento APIs into Postman
        • Authentication with Azure AD Token
        • Permission Sets
        • Obtaining the AD App-Only Token
      • Migrations
        • Response API Migration
        • Indexing API Migration
      • Integrations
        • Voice Call API Integration Guide
        • Staging & Publishing for Agents API Guide
        • Chat Thread Attachment Integration Guide
        • App-Only Token Login — Integration Guide
    • Authentication
      • Getting Started with Authentication
      • Authentication and Token Refresh Guide
      • SSO
        • Initiate Google SSO Login
        • Initiate Microsoft SSO Login
        • Initiate LinkedIn SSO Login
        • Initiate Okta SSO Login
        • Exchange Azure AD Token for Ejento Tokens
        • Exchange an Azure AD App-Only Token for Ejento Tokens
        • Initiate Microsoft CIAM SSO Login (Azure AD B2C or Entra External ID)
      • Feature Flags
        • Get Login Feature Flags
      • Authenticate User
      • Request Passwordless Exchange Token
      • Exchange Passwordless Token for Access Tokens
      • Register User
      • Refresh Access Token
      • Update Own Password
      • Validate Magic Link Token
      • Passwordless Authentication (Email Magic Link)
      • Verify Email OTP
      • Request Password Recovery Email
      • Reset Password
    • 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 or Organization
        • Get all Tags grouped by Agent for a given Project 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 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
      • Evaluation Datasets
        • List Agent Evaluation Datasets
        • Create Agent Evaluation Dataset
        • Batch Delete Agent Evaluation Datasets
        • Get Agent Evaluation Dataset
        • Update Agent Evaluation Dataset
        • Delete Agent Evaluation Dataset
        • Upload Agent Evaluation Dataset (CSV/Excel)
      • Evaluation Runs
        • List Agent Evaluation Runs
        • Create Agent Evaluation Run
        • Batch Delete Agent Evaluation Runs
        • Get Agent Evaluation Run
        • Update Agent Evaluation Run
        • Delete Agent Evaluation Run
      • Agent Permissions
        • List all permissions on an agent
        • Grant permission on an agent
        • Update a permission on an agent
        • Revoke permission on an agent
        • Grant multiple permissions on an agent
        • Revoke multiple permissions on an agent
        • Get user permissions on a specific agent
        • Get user permissions on multiple agents
      • Agent Skills
        • Get all Skills available to an Agent
        • Unlink a Skill from an Agent
        • Link a Skill to an Agent
      • Get all Agents
      • Create a new Agent
      • Get an Agent
      • Update an Agent
      • Delete an Agent
      • Activate an Agent
      • Get Agent-Corpus Connections
      • Create Multiple 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
      • Get a single agent history record by history ID
      • Create Custom Instructions for an Agent
      • Update Custom Instructions for an Agent
      • Delete a Custom Instruction 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 all Character Voices
      • 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 workflows for an agent
      • Get all Starred Agents of the Authenticated User
      • Get Staging Diff
      • Get publish history for an agent
      • Get rollback diff preview for a publish record
      • Roll back staging agent to a previous publish
      • Publish staging agent to main
      • Clone an Agent
      • Get diff detail for a publish record
    • Agent Response
      • Stream Agent Response (SSE)
      • Generate Agent Response (Non-Streaming)
      • Generate Token for Voice Call
      • Get an Agent Response
      • Update an Agent Response
      • 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
      • Create Bulk Agent Response Logs
      • Stop an in-flight streaming response
      • Resume a Streamed Response (SSE)
    • 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 Workflow Summary Statistics
      • Get Query Count Data
      • Get Token Data
    • 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
      • Thread Share
        • List Thread Shares
        • Create Thread Share
        • Update Thread Share
        • Get Thread Share Settings
        • Refresh Thread Share Snapshot
        • View Thread Share
        • Get Thread Share Access Log
        • Revoke Thread Share
      • Get Chat Thread
      • Update Chat Thread
      • Delete Chat Thread
      • Get Chat Threads based on various filters
      • Global Hybrid Search across Chat Threads and Chatlogs
      • Get Recent Chat Threads across all Agents
    • Chat Logs
      • Get Chat Log Details
      • Get Chat Log Search Results
    • Corpora
      • Corpus Permissions
        • Get all Permissions for a Corpus
        • Grant permission on a corpus
        • Update a permission on a corpus
        • Revoke permission on a corpus
        • Batch grant permissions on a corpus
        • Batch revoke permissions on a corpus
        • Get calling user's permissions on a corpus
        • Get a user's permissions on a corpus
        • Get a user's permissions across multiple 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
      • Trigger a Refresh (Reindex) of a Corpus
      • Get Sitemaps for a Corpus
      • Get Corpora with Refresh (Reindex) Enabled
    • Conversation Starters
      • Get Conversation Starters for an Agent
      • Create a new Conversation Starter.
    • Citation
      • Get Citation File Content
    • Configurations
      • Update the LLM configuration for an Agent
      • Get OAuth-related Feature Flags
    • 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
    • Feature Flags
      • Get All Feature Flags
      • Get Agent Alias Feature Flag
      • Get Agent Evaluation Feature Flag
      • Get Api Tools Feature Flag
      • Get Caching Feature Flag
      • Get Call Feature Flag
      • Get Chat Agent Creation Feature Flag
      • Get Chat Widget Feature Flag
      • Get dall_e Image Generation Feature Flag
      • Get Developer Portal Feature Flag
      • Get Flush Cache Feature Flag
      • Get Google Drive Connector Feature Flag
      • Get Guardrail Feature Flag
      • Permission Sets Feature Flag
      • Get PII Redaction Feature Flag
      • Get Share Agent Feature Flag
      • Get Sharepoint Legacy Feature Flag
      • Show Quota Limit Feature Flag
      • Get Skills Feature Flag
      • Get Staging Agent Feature Flag
      • Get Workflow Evaluation Feature Flag
      • Get Youtube Index Feature Flag
    • Guardrails
      • Apply Guardrails on Input Text
      • 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
    • Google Drive
      • Folder Mappings
        • Get Google Drive Folder Mappings by Corpus ID
    • Metering
      • Get Spend Limits
      • Spend Enforcement Check
      • Set Org Spend Limit
      • Set Default User Spend Limit
      • Set Per-User Spend Limit Override
      • Remove Per-User Spend Limit Override
      • Get Per-User Spend Limit Override
      • Get Governance Settings
      • Update Governance Settings
      • Request Spend Limit Increase
      • List Spend Limit Increase Requests
      • Approve Spend Limit Increase Request
      • Deny Spend Limit Increase Request
      • Get Spend Overview
      • Get Spend Trends Summary
      • Get Daily Spend Trend
      • Get Spend By Model
      • Get Spend By Assistant
      • Get Spend Users Table
      • Get Spend User Detail
      • Get My Spend
    • Notifications
      • Get all Notifications
      • Create a new Notification
      • Update Notifications by User ID
      • Get a Notification
      • Update a Notification
      • Delete a Notification
    • Organizations
      • Organization Permissions
        • List all permissions on an organization
        • Get My Organization Permissions
        • Get user permissions on a specific organization
      • 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
      • Register LLM Configuration
      • Update LLM Configuration
      • Toggle LLM Configuration Availability
      • Delete LLM Configuration
      • Get a specific LLM configuration by ID (admin only)
    • Projects
      • Project Permissions
        • List all permissions on a project
        • Grant permission on a project
        • Update a permission on a project
        • Revoke permission on a project
        • Grant multiple permissions on a project
        • Revoke multiple permissions on a project
        • Get user permissions on a specific project
        • Get user permissions on multiple 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
    • Permission Sets
      • List org permission sets
      • Create a permission set
      • Retrieve a permission set
      • Update a permission set
      • Delete a permission set
      • List permission set members
      • Assign one or more members to a permission set
      • Remove one or more members from a permission set
    • Skills
      • List all Skills in an Organization
      • Create a new Skill
      • Retrieve a Skill in an Organization
      • Update a Skill
      • Disable a Skill for all Agents in an Organization
      • Update Skill Metadata
      • Enable a Skill for all Agents in an Organization
      • Delete a Skill
      • Get a Skill with Content
      • Get a File from a Skill
      • Download a Skill as a Zip Archive
    • Sitemaps
      • Get a Sitemap
      • Toggle Sitemap Syncing
      • Delete a Sitemap (cascade)
      • Get documents linked to a Sitemap
    • Tools
      • Get Tool by ID
      • Update Tool by ID
      • Delete Tool by ID
    • Teams
      • Team Permissions
        • List all permissions on a team
        • Grant permission on a team
        • Update a permission on a team
        • Revoke permission on a team
        • Grant multiple permissions on a team
        • Revoke multiple permissions on a team
        • Get user permissions on a specific team
        • Get user permissions on multiple teams
      • Get all Teams
      • Create a Team
      • Get a Team
      • Update a Team
      • Delete a Team
      • Get a team's permission sets and effective permissions
      • Preview a team's permissions after assigning/removing permission sets
      • 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
      • Get Recent Teams
      • Get all Teams of the Authenticated User
    • Users
      • Get a User
      • Update a User
      • Delete a User
      • Get Agent Responses of a User
      • Assign a user to multiple permission sets
      • Get all User Permissions
      • Preview a user's permissions after assigning/removing permission sets
      • 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
    • Workflows
      • Evaluation Datasets
        • List Workflow Evaluation Datasets
        • Create Workflow Evaluation Dataset
        • Batch Delete Workflow Evaluation Datasets
        • Get Workflow Evaluation Dataset
        • Update Workflow Evaluation Dataset
        • Delete Workflow Evaluation Dataset
        • Upload Workflow Evaluation Dataset (CSV/Excel)
      • Evaluation Runs
        • List Workflow Evaluation Runs
        • Create Workflow Evaluation Run
        • Batch Delete Workflow Evaluation Runs
        • Get Workflow Evaluation Run
        • Update Workflow Evaluation Run
        • Delete Workflow Evaluation Run
      • Workflow Permissions
        • Get all Permissions for a Workflow
        • Grant permission on a Workflow
        • Update a permission on a Workflow
        • Revoke permission on a Workflow
        • Batch grant permissions on a Workflow
        • Batch revoke permissions on a Workflow
        • Get a user's permissions on a workflow
        • Get a user's permissions across multiple workflows
      • Get all Workflows
      • Stream Workflow Response (SSE)
      • Create a Workflow
      • Get a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Get all Workflow Chat Threads
      • Create a Workflow Chat Thread
      • Get all Workflow Responses
      • 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
      • Get Workflow Responses based on filters

    Agent Response

    Stream Agent Response (SSE)
    POST/response-service/api/v2/agents/{agent_id}/responses/stream
    Ask an agent a question and receive the answer in real time as a streamed agent response. You receive progress updates and reasoning steps as they hap...
    Generate Agent Response (Non-Streaming)
    POST/response-service/api/v2/agents/{agent_id}/responses
    Ask an agent a question and get back a complete answer in an agent response. The agent searches configured corpora (knowledge bases), when available, ...
    Generate Token for Voice Call
    POST/response-service/api/v2/agents/{agent_id}/voice-chat
    Set up a voice call with an agent. You get a token to join the call and can continue an existing chat thread (conversation). See Voice Calling Guide f...
    Get an Agent Response
    GET/api/v2/agent-responses/{agent_response_id}
    This endpoint allows users to retrieve detailed information about a specific agent's response using its unique response ID.This endpoint is partic...
    Update an Agent Response
    PUT/api/v2/agent-responses/{agent_response_id}
    Allows users to update fields of an existing agent response. Path Parameters: agent_response_id: ID of the agent response to be updated Request Body...
    Delete an Agent Response
    DELETE/api/v2/agent-responses/{agent_response_id}
    This endpoint allows users to permanently remove a specific agent response from the system using its unique response ID.This is useful for maintaining...
    Get Comments for Agent Response
    GET/api/v2/agent-responses/{agent_response_id}/comments
    The Get Comments for Agent Response API endpoint allows users to retrieve comments associated with a specific agent response.This feature enables user...
    Create a Comment for Agent Response
    POST/api/v2/agent-responses/{agent_response_id}/comments
    The Create Agent Response Comment API endpoint allows users to add a comment to a specific agent response.This feature enables users to provide feedba...
    Create a Feedback for an Agent Response
    POST/api/v2/agent-responses/{agent_response_id}/feedbacks
    The Create Agent Response Feedback API endpoint allows users to submit feedback on a specific agent-generated response.Feedback helps improve AI perfo...
    Pin an Agent Response
    PUT/api/v2/agent-responses/{agent_response_id}/pin
    The Pin Agent Response API allows users to pin a specific agent response, ensuring it remains highlighted and easily accessible in the system. Path Pa...
    Unpin an Agent Response
    DELETE/api/v2/agent-responses/{agent_response_id}/pin
    The Unpin Agent Response API allows users to unpin a specific agent response, removing it from the highlighted list and restoring its normal visibilit...
    Get Supporting Content of an Agent Response
    GET/api/v2/agent-responses/{agent_response_id}/supporting-content
    This endpoint allows users to retrieve supporting content about a specific agent's response using its unique response ID. Query Parameters: all_s...
    Get Thoughts of an Agent Response
    GET/api/v2/agent-responses/{agent_response_id}/thoughts
    This endpoint allows users to retrieve thoughts about a specific agent's response using its unique response ID. Query Parameters: all_sources (bo...
    Get Agent Responses based on filters
    POST/api/v2/agent-responses/dashboard
    The Get Agent Responses based on filters API endpoint allows users to retrieve agent responses based on various filters.This feature enables users to ...
    Get Agent Responses of an Agent
    GET/api/v2/agents/{agent_id}/responses
    Allows retrieving agent responses filtered by agent id. This endpoint supports pagination and filtering options. Staging behaviour: Pass agent_versio...
    Create Agent Response Log
    POST/api/v2/agents/{agent_id}/responses/log
    This endpoint is used to save chat interactions. Staging behaviour: Pass agent_version=staging as a query parameter to log the response against the s...
    Get Pinned Agent Responses
    GET/api/v2/agents/{agent_id}/responses/pin
    Get pinned chat logs for a specific agent. Staging behaviour: Pass agent_version=staging as a query parameter to fetch pinned responses for the stagi...
    Create Bulk Agent Response Logs
    POST/api/v2/agents/{agent_id}/responses/log/bulk_create
    This endpoint is used to save multiple chat interactions in bulk by fetching logs from a shared thread.Supports partial success - some logs may succee...
    Stop an in-flight streaming response
    POST/response-service/api/v2/agents/{agent_id}/responses/{run_id}/stop-requests
    Stop a response that is currently generating. The text produced so far is kept, and the response ends gracefully. The request returns immediately; the...
    Resume a Streamed Response (SSE)
    GET/response-service/api/v2/agents/{agent_id}/responses/{run_id}/resume-events
    Replay saved events from a response started with keep_generating: true, then continue receiving new events while it is still generating. Pass last_eve...
    Previous
    Get diff detail for a publish record
    Next
    Stream Agent Response (SSE)
    Built with