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

    Evaluations

    Retrieve all evaluations or filter by dataset
    GET/api/v2/agents/{agent_id}/evaluations
    Get all evaluations. Path Parameters: agent_id: ID of the agent to retrieve evaluations for Query Parameters: dataset_id: ID of the dataset to filt...
    Create a new evaluation
    POST/api/v2/agents/{agent_id}/evaluations
    Create a new evaluation. Path Parameters: agent_id: ID of the agent to create the evaluation for Request Body:JSON object containing the evaluation ...
    Delete a set of evaluations or a specific evaluation
    DELETE/api/v2/agents/{agent_id}/evaluations
    Delete a set of evaluations or a specific evaluation. Path Parameters: agent_id: ID of the agent to delete evaluations for Request Body:JSON object ...
    Retrieve all evaluation datasets for a specific agent
    GET/api/v2/agents/{agent_id}/evaluations/datasets
    Retrieve all evaluation datasets for a specific agent. Path Parameters: agent_id: ID of the agent to retrieve datasets for Query Parameters: query:...
    Create a new evaluation dataset for the given agent
    POST/api/v2/agents/{agent_id}/evaluations/datasets
    Create a new evaluation dataset for the given agent. Path Parameters: agent_id: ID of the agent to create the dataset for Request Body:JSON object c...
    Delete multiple datasets or all datasets for an agent
    DELETE/api/v2/agents/{agent_id}/evaluations/datasets
    Handle DEL requests to delete multiple dataset or delete dataset by agent Path Parameters: agent_id: ID of the agent to delete datasets for Request ...
    Retrieve a specific evaluation
    GET/api/v2/evaluations/{eval_run_id}
    Get specific evaluation. Path Parameters: eval_run_id: ID of the evaluation to retrieve Query Parameters: dataset_id: ID of the dataset(s) to filte...
    Update an evaluation run
    PUT/api/v2/evaluations/{eval_run_id}
    Update Evaluation Run
    Delete a specific evaluation
    DELETE/api/v2/evaluations/{eval_run_id}
    Delete a specific evaluation
    List query results for an evaluation run
    GET/api/v2/evaluations/{eval_run_id}/query-results
    Get all Query Results or filter by dataset id
    Create a query result and save metrics
    POST/api/v2/evaluations/{eval_run_id}/query-results
    Create a query result and save corresponding scores in MetricResult table
    Retrieve a specific dataset
    GET/api/v2/evaluations/datasets/{dataset_id}
    Retrieve a specific evaluation dataset by its ID. Path Parameters: dataset_id: ID of the dataset to retrieve Returns:JSON response with object conta...
    Update an evaluation dataset
    PUT/api/v2/evaluations/datasets/{dataset_id}
    Handle PUT requests to update an evaluation dataset. Path Parameters: dataset_id: ID of the dataset to update Request Body:JSON object containing th...
    Delete a specific dataset
    DELETE/api/v2/evaluations/datasets/{dataset_id}
    Handle DELETE requests to remove a specific evaluation dataset from the system. Path Parameters: dataset_id: ID of the dataset to delete Returns:JSO...
    Retrieve queries for an evaluation dataset
    GET/api/v2/evaluations/datasets/{dataset_id}/queries
    Retrieve queries for an evaluation dataset
    Create a new query for evaluation
    POST/api/v2/evaluations/datasets/{dataset_id}/queries
    Create a new query for evaluation
    Retrieve all unique tags from all datasets in the organization
    GET/api/v2/evaluations/datasets/tags
    Retrieve all unique tags from all datasets in the organization.If dataset_ids are provided, only return tags from those specific datasets. Returns:JSO...
    Get a specific metric result by ID
    GET/api/v2/evaluations/metric-result/{metric_result_id}
    Get a specific metric result. Path Parameters: metric_result_id: ID of the metric result to retrieve Returns:JSON response with object containing me...
    Retrieve all metrics or filter by category name
    GET/api/v2/evaluations/metrics
    Get all metrics or filter by catgeory name. Query Parameters: category_name: Name of the category to filter metrics by Returns:JSON response with li...
    Create a new metric
    POST/api/v2/evaluations/metrics
    Create a new metric. Request Body:JSON object containing the metric details Returns:JSON response with object containing created metric
    Retrieve a specific metric
    GET/api/v2/evaluations/metrics/{metric_id}
    Get a specific metric. Path Parameters: metric_id: ID of the metric to retrieve Returns:JSON response with object containing metric details
    Update a metric
    PUT/api/v2/evaluations/metrics/{metric_id}
    Update Metric details. Path Parameters: metric_id: ID of the metric to update Request Body:JSON object containing the updated metric details Returns...
    Delete a metric
    DELETE/api/v2/evaluations/metrics/{metric_id}
    Delete a specific metric. Path Parameters: metric_id: ID of the metric to delete Returns:JSON response with success message or error message
    Get all metric results for a specific metric
    GET/api/v2/evaluations/metrics/{metric_id}/results
    Get all metric results for a specific metric
    Create a new metric result entry for the given metric
    POST/api/v2/evaluations/metrics/{metric_id}/results
    Create a new metric result entry for the given metric. Path Parameters: metric_id: ID of the metric to create a result for Request Body:JSON object ...
    Retrieve a specific evaluation query
    GET/api/v2/evaluations/queries/{eval_query_id}
    Retrieve specific query
    Update an evaluation query
    PUT/api/v2/evaluations/queries/{eval_query_id}
    update evaluation query attributes
    Delete an evaluation query
    DELETE/api/v2/evaluations/queries/{eval_query_id}
    delete an evaluation query
    Get a specific query result with metrics
    GET/api/v2/evaluations/query-results/{query_result_id}
    Get a specific Query Result
    Update a query result
    PUT/api/v2/evaluations/query-results/{query_result_id}
    Update Query Result
    Previous
    Get OAuth-related Feature Flags
    Next
    Retrieve all evaluations or filter by dataset
    Built with