Ejento APIs
V2 Legacy
  • Stable
  • V2
  • V2 Legacy
  1. Agent
Ejento APIs
V2 Legacy
  • Stable
  • V2
  • V2 Legacy
  • Overview
  • Endpoints
    • Agent
      • Create Agent By Agent Builder
        POST
      • Create Agent By Configure
        POST
      • Get All Agents
        GET
      • Get Agent By Team
        GET
      • Get Agent By User Team
        GET
      • Agent Filtered
        GET
      • Get Agent
        GET
      • Edit Agent
        PUT
      • Get Recent Agents
        GET
      • Create Recent Agent
        POST
      • Delete Recent Agent
        DELETE
      • Get Starred Agents
        GET
      • Create Starred Agent
        POST
      • Delete Starred Agent
        DELETE
    • Agent Corpus Connection
      • Create Agent Corpus Connection
      • Get Agent Corpus Connection
      • Edit Agent Corpus Connection
      • Delete Agent Corpus Connection
      • Get All Agent Corpus Connections
      • Delete All Agent Corpus Connections
    • Agent Response
      • Create Agent Response
      • Get All Agent Responses
      • Get Agent Responses By User
      • Get Agent Responses By Project
      • Get Agent Responses By Chat Thread
      • Get Agent Response
      • Delete Agent Response
      • Create Agent Response Comment
      • Get Agent Response Comment
      • Get Agent Response Dashboard
      • Create Agent Response Feedback
      • Create Agent Response Log
      • Pin Agent Response
      • Unpin Agent Response
      • Get Pinned Agent Responses
    • Agent Reviews
      • Create Review
      • Get All Reviews
      • Get Reviews by Agent
      • Delete Review
    • Agent Rating
      • Get All Agent Ratings
      • Get Agent Rating
      • Update Agent Rating
    • Agent Alias
      • Get All Agent Aliases
      • Create Agent Alias
      • Update Agent Alias
      • Delete Agent Alias
    • Agent Access
      • Get Agent Access
      • Update Agent Access
    • Agent Type
      • Get All Agent Types
      • Get Agent Type
      • Update Agent Type
    • Agent User
      • Add Users to Agent
      • Get Users Of Agent
      • Delete User from Agent
      • Get User Agent Permission
      • Get All Agents with Users
    • Agent Tags
      • Get All Distinct Agent Tags
      • Annotate an Agent with Tags
    • Agent Vote
      • Create Agent Vote
      • Get Agent Vote
    • Agent Comment
      • Create Comment on an Agent
      • Get Comments for an Agent
      • Edit Agent Comment
    • Chat Thread
      • Create Chat Thread
      • Get All Chat Threads Of An Agent
      • Get All Chat Threads With Admin Panel Filters And Pagination
      • Get Reduced Chatlogs by Thread ID for Admin Panel
      • Get Chat Thread
      • Edit Chat Thread
      • Delete Chat Thread
      • Add ChatThread-Corpus Connection
      • Get ChatThread-Corpus Connection
      • Delete ChatThread-Corpus Connection
    • Project
      • Create Project
      • Get All Projects
      • Project Filtered
      • Get All Agents Of Project
      • Get All Projects By Team
      • Get Project
      • Edit Project
      • Delete Project
      • Fetch Project Details
      • Add Recent Project
      • Get Recent Projects
    • User Project
      • Add Users To Project
      • Get All Projects By User Teams
      • Get Projects By User and Team
      • Delete Users from Project
    • Document
      • Get Document
      • Edit Document
      • Add Or Remove Tags On Document
      • Document Polling
      • Trigger a refresh(reindex) of a Document
    • Corpus
      • Create Corpus
      • Get All Corpus
      • Get Corpus
      • Edit Corpus
      • Delete Corpus
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete Document(s) from Corpus
      • Check Duplicate Documents
      • Get All Agents By Corpus
      • Get Corpus Permissions
      • Get Corpus Permission By User
      • Annotate Corpus
      • Trigger a refresh(reindex) of a Corpus
    • Notification
      • Create Notification
      • Retrieve All Notifications
      • Read Notifications By User ID
      • Retrieve Notification
      • Read Notification
      • Delete Notification
    • Feature Flag
      • Get All Feature Flags
      • Get DALL-E Feature Flag
      • Get Share Agent Feature Flag
      • Get Agent Alias Feature Flag
      • Get SharePoint Index Feature Flag
      • Get Chat Agent Creation Feature Flag
      • Get OAuth Feature Flags
      • Get Google OAuth Feature Flag
      • Get LinkedIn OAuth Feature Flag
      • Get MS SSO OAuth Feature Flag
      • Get Github OAuth Feature Flag
    • Team
      • Create Team
      • Get All Teams
      • Get Team Details
      • Edit Team
      • Delete Team
      • Create Recent Team
      • Get Recent Teams
      • Add Users to Team
      • Get Users in a Team
      • Get Teams Of User
      • Get User Role By Team
      • Get Agents Of User Team
      • Get Projects And Team
    • User
      • Create User In Organization
      • Get All Users By Organization
      • Get User
      • Edit User
      • Delete User
      • Batch Delete Users
      • User Filtered
      • Create User Permission
      • Get User Permission
      • Edit User Permission
      • Delete User Permission
    • Email Indexing Authorization
      • Email Authorize
    • Conversation Starters
      • Create Conversation Starter
      • Get Conversation Starters
    • Tool
      • Create Tool
      • Get All Tools
      • Get Tool
      • Edit Tool
      • Delete Tool
    • Agent Tool Connection
      • Enable Agent Tool
      • Get All Agent Tools
      • Disable Agent Tool
    • Organization Tool
      • Enable Organization Tool
    • API Tool Template
      • Create API Tool Template
      • Get All API Tool Templates
    • LLM Config
      • Get All LLM Configs
      • Get Active Config
      • Get LLM Config
      • Get Model Deployment
      • Get Org Configs
      • Set Agent Config View
  1. Agent

Create Starred Agent

POST
/v2/api/agent/{agent_id}/starred
Adds an agent to the Starred List, making it easily accessible for quick reference.
This is useful for prioritizing frequently used agents and improving workflow efficiency.

What is a Starred Agent?#

A Starred Agent is an agent that you mark as important, allowing it to appear in favorites section for quick access.
This feature helps in managing frequently used agents without needing to search for them every time.

Purpose of Starring an Agent#

Starring an agent serves several key purposes:
Quick Access: Find important agents faster in your workspace.
Better Organization: Keep frequently used agents separate from the rest.

What Happens When You Star an Agent?#

The agent is added to the Starred List, making it available in the Favorites section.
This action does not change the agent's functionality or permissions.
You can later remove the agent from the starred list if needed.

How to Retrieve a Starred Agent?#

After starring an agent, you can retrieve it using the Get Starred Agents endpoint:
👉 Get Starred Agents

How to View Your Agent ID?#

To star an agent, you need to know its Agent ID, refer to this guide:
👉 View Your Agent ID

Step-by-Step Guide of Favorite Agents#

To follow a detailed, step-by-step guide on Starring an agent, visit:
Favorite Agents Guide
📝 Note: In Ejento AI, the terms "Assistant" and "Agent" are interchangeable.

Request

Path Params

Header Params

Responses

🟢201Created
application/json
Starred agent created successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https:///v2/api/agent/0/starred' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '
Response Response Example
201 - Success
{
    "success": true,
    "message": "Starred Agent created successfully",
    "data": {
        "id": 288,
        "agent": {
            "id": 1251,
            "user": {
                "id": 160,
                "email": "[email protected]",
                "first_name": "User",
                "last_name": "User",
                "organization": 1
            },
            "agent_type": {
                "id": 1,
                "created_by": "System",
                "created_on": "2024-04-17T23:10:22.313394Z",
                "modified_by": "[email protected]",
                "modified_on": "2024-04-17T23:10:22.313414Z",
                "name": "QnA",
                "description": ""
            },
            "instructions": [
                {
                    "id": 10353,
                    "instruction": "",
                    "is_deleted": false,
                    "created_by": "[email protected]",
                    "created_on": "2025-01-07T16:45:24.058906Z",
                    "agent": 1251
                }
            ],
            "agent_name": "Policy Whisperer",
            "industry_area": "",
            "domain": "Provides accurate and concise answers to inquiries regarding company policies.",
            "sample_q1": "What is user's favorite sport?",
            "sample_q2": "Who is user's favorite player?",
            "sample_q3": "What is user's favorite food?",
            "prefix_prompt": "You are an AI assistant designed to answer questions about company policies.",
            "alias": "[email protected]",
            "is_active": false,
            "is_deleted": false,
            "created_by": "[email protected]",
            "created_on": "2025-01-07T16:45:23.953362Z",
            "agent_image": "[object Object]",
            "access": "Only me",
            "status": "Live",
            "caching_enabled": false,
            "chunk_count": 32,
            "react_enabled": true,
            "react_max_iteration_count": 50,
            "project": 43,
            "llm_config": 8,
            "cloned_from": null
        }
    }
}
Previous
Get Starred Agents
Next
Delete Starred Agent
Built with