Ejento APIs
V1
  • V2
  • V1
  1. Agent APIs
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
        GET
      • Add to Recent Agents
        POST
      • Delete Recent Agent
        DELETE
      • Get Starred Agents
        GET
      • Delete Starred Agents
        DELETE
      • Get Agents by Team or User Team
        GET
      • Create a Review for an Agent
        POST
      • Get Agent Reviews
        GET
      • Update an Agent Review
        PUT
      • Delete an Agent Review
        DELETE
      • Create Agent Chat
        POST
      • Get Agent Ratings
        GET
      • Toggle Rating
        PUT
      • Create Agent Alias
        POST
      • Get All Agent Alias
        GET
      • Update Agent Alias
        PUT
      • Get Agent Access Level
        GET
      • Update Agent Access Level
        PUT
      • Get All Agents by Project
        GET
      • Get Agent Types
        GET
      • Update Agent Type
        PUT
      • Get User Agent or User Agent Permission
        GET
    • 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
  1. Agent APIs

Get Starred Agents

GET
/starredagents/{agent_id}
Agent APIs
Fetch a list of starred agents with optional limit query parameter.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/starredagents/'
Response Response Example
{
    "success": true,
    "message": "status code 200: Starred Agent fetched successfully",
    "data": [
        {
            "id": 12,
            "agent": {
                "id": 3,
                "user": {
                    "id": 3,
                    "email": "user@example.com",
                    "first_name": null,
                    "last_name": null,
                    "organization": 1
                },
                "agent_type": {
                    "id": 1,
                    "created_by": "System",
                    "created_on": "2024-08-23T21:38:47.044052Z",
                    "modified_by": "",
                    "modified_on": "2024-08-23T21:38:47.044079Z",
                    "name": "SampleAgent",
                    "description": "Sample description"
                },
                "instructions": [
                    {
                        "id": 1,
                        "instruction": "",
                        "is_deleted": false,
                        "created_by": "user@example.com",
                        "created_on": "2024-08-28T20:06:07.967094Z",
                        "agent": 3
                    }
                ],
                "agent_name": "Sample Agent",
                "industry_area": "",
                "domain": "",
                "sample_q1": "",
                "sample_q2": "",
                "sample_q3": "",
                "prefix_prompt": "",
                "alias": "Agent_67-dev@ejento.ai",
                "is_active": false,
                "is_deleted": false,
                "created_by": "user@example.com",
                "created_on": "2024-08-28T20:06:07.953849Z",
                "agent_image": "/build/static/media/defaultBotImg3.9f06e9226b3fe33a93c9.png",
                "access": "Public",
                "status": "Live",
                "project": 1,
                "llm_config": 1,
                "cloned_from": null
            }
        }
    ]
}

Request

Path Params
agent_id
string 
required
Query Params
limit
integer 
optional
Maximum number of starred agents to return.

Responses

🟢200OK
application/json
Starred agents fetched successfully.
Body
success
boolean 
optional
Indicates if the request was successful.
message
string 
optional
Status message.
data
array [object {2}] 
optional
id
integer 
optional
ID of the starred agent entry.
agent
object 
optional
Previous
Delete Recent Agent
Next
Delete Starred Agents