Ejento APIs

Stable

Stable
V2
V2 Legacy

Schemas

Ejento APIs

Stable

Stable
V2
V2 Legacy

Overview
Changelog
Versioning
FAQs
Guides
- How to generate API Key and Auth Token
- Build an App with Ejento APIs
- Quick-Start Template for Building an App
- 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
- 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
- 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
- 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 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 Starred Agents of the Authenticated User
- Get Agents accessible to the Current User across their Teams
- Get Agents by Project team, User team
- Create Multiple Agent-Corpus Connections
Agent Response
- Get an Agent Response
- Stream Agent Response (SSE)
- Generate Agent Response (Non-Streaming)
- 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
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
- 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 Sitemaps for 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
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
Guardrails
- Get available guardrail types for agent
- Enable/disable a guardrail type for agent
- Get Guardrails
- Apply Guardrails on Input Text
- 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 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 Guardrail Feature Flag
- Get PII Redaction Feature Flag
- Get Share Agent Feature Flag
- Get Flush Cache Feature Flag
- Show Quota Limit Feature Flag
- Get Youtube Index Feature Flag
- Get Workflow Evaluation 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
- 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
- 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
- Get all Workflows
- Create a Workflow
- Get a Workflow
- Stream Workflow Response (SSE)
- 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
- Get all Workflow Responses
Citation
- Get Citation File Content
Sitemaps
- Get a Sitemap
- Toggle Sitemap Syncing
- Delete a Sitemap (cascade)
- Get documents linked to a Sitemap
Schemas
- Latest
  - Schemas
- Legacy
  - Schemas
- Services
  - Schemas

Schemas

UserPublic(UserPublic)

{
    "email": "[email protected]",
    "is_active": true,
    "is_superuser": false,
    "full_name": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}