Get Starred Agents

GET

/v2/api/agent/starred

Agent

Retrieves the list of Starred Agents, providing quick access to agents marked as important.
This helps in managing frequently used agents efficiently within the workspace.

What is a Starred Agent?

A Starred Agent is an agent that a user has manually marked as important for quick reference.
These agents appear in a dedicated Starred List, allowing users to easily find and access them.

To star an agent, use the Create Starred Agent endpoint.

To remove an agent from the starred list, use the Delete Starred Agent endpoint.

For more detailed information about agent, refer to the Agent Guide.

📝 Note: "Assistant" is another name for "Agent".

Response Example

200 - Example 1

{
    "success": true,
    "message": "Starred Agent fetched successfully",
    "data": [
        {
            "id": 325,
            "agent": {
                "id": 1507,
                "user": {
                    "id": 1,
                    "email": "admin@ejento.ai",
                    "first_name": "Ejento",
                    "last_name": "Admin",
                    "organization": 1
                },
                "agent_type": {
                    "id": 1,
                    "created_by": "System",
                    "created_on": "2024-04-17T23:10:22.313394Z",
                    "modified_by": "zaidi@example.com",
                    "modified_on": "2024-04-17T23:10:22.313414Z",
                    "name": "QnA",
                    "description": ""
                },
                "instructions": [
                    {
                        "id": 11472,
                        "instruction": "",
                        "is_deleted": false,
                        "created_by": "admin@ejento.ai",
                        "created_on": "2025-04-07T20:51:58.445022Z",
                        "agent": 1507
                    }
                ],
                "project": {
                    "id": 119,
                    "project_name": "Workflow Feature",
                    "team": {
                        "id": 205,
                        "team_name": "Fahad Team"
                    }
                },
                "connected_tool_names": [
                    "Rag Tool",
                    "Attachment Tool"
                ],
                "tags": [],
                "character_voice": null,
                "agent_name": "AI Companion for M&A Team",
                "industry_area": "",
                "domain": "",
                "sample_q1": "",
                "sample_q2": "",
                "sample_q3": "",
                "prefix_prompt": "",
                "alias": "AICompanionforM&ATeam_1507-dev@ejento.ai",
                "is_active": false,
                "is_deleted": false,
                "created_by": "admin@ejento.ai",
                "created_on": "2025-04-07T20:39:21.519333Z",
                "agent_image": "[object Object]",
                "access": "Only me",
                "status": "Live",
                "caching_enabled": false,
                "chunk_count": 32,
                "attachment_chunk_count": 3,
                "attachment_chunking": false,
                "react_enabled": true,
                "react_max_iteration_count": 50,
                "llm_config": 8,
                "cloned_from": null
            }
        }
    ]
}

Request

Query Params

limit

integer

optional

Specifies the maximum number of recent agents to fetch.
If omitted, the default value will be used.

>= 1

Example:

Responses

🟢200OK

application/json

Successfully retrieved the starred agents.

Body

success

boolean

optional

Indicates if the API call was successful

Example:

true

message

string

optional

Descriptive message about the API response

Example:

Starred Agent fetched successfully

data

array [object {2}]

optional

List of starred agent data entries

integer <int64>

optional

Unique identifier for the starred agent record

Example:

325

agent

object

optional

Information about the agent

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Delete Recent Agent

Create Starred Agent

Get Starred Agents

What is a Starred Agent?#

Related Actions#

Request

Responses

What is a Starred Agent?

Related Actions