Get Starred Agents

GET

/v2/api/agent/starred

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".

Request

Query Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved the starred agents.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/agent/starred?limit' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Starred Agent fetched successfully",
    "data": [
        {
            "id": 325,
            "agent": {
                "id": 1507,
                "user": {
                    "id": 1,
                    "email": "[email protected]",
                    "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": "[email protected]",
                    "modified_on": "2024-04-17T23:10:22.313414Z",
                    "name": "QnA",
                    "description": ""
                },
                "instructions": [
                    {
                        "id": 11472,
                        "instruction": "",
                        "is_deleted": false,
                        "created_by": "[email protected]",
                        "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&[email protected]",
                "is_active": false,
                "is_deleted": false,
                "created_by": "[email protected]",
                "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
            }
        }
    ]
}

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