Create Starred Agent
POST
/v2/api/agent/{agent_id}/starred
Agent
This is useful for prioritizing frequently used agents and improving workflow efficiency.
What is a Starred Agent?
This feature helps in managing frequently used agents without needing to search for them every time.
Purpose of Starring an Agent
What Happens When You Star an Agent?
How to Retrieve a Starred Agent?
👉 Get Starred Agents
How to View Your Agent ID?
👉 View Your Agent ID
Step-by-Step Guide of Favorite Agents
Favorite Agents Guide
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/api/agent//starred'
Response Response Example
201 - Create starred agent
{
"success": true,
"message": "Starred Agent created successfully",
"data": {
"id": 288,
"agent": {
"id": 1251,
"user": {
"id": 160,
"email": "user@example.com",
"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": "user@example.com",
"modified_on": "2024-04-17T23:10:22.313414Z",
"name": "QnA",
"description": ""
},
"instructions": [
{
"id": 10353,
"instruction": "",
"is_deleted": false,
"created_by": "user@example.com",
"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": "PolicyWhisperer_1251-dev@ejento.ai",
"is_active": false,
"is_deleted": false,
"created_by": "user@example.com",
"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
}
}
}
Request
Path Params
agent_id
integer
required