Get All Agents with Users
GET
/v2/api/agent/user
Agent User
Each agent entry includes metadata such as the agent type, assigned users, projects,
industry domain, and other relevant attributes.
and training progress.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/api/agent/user'
Response Response Example
200 - Example 1
{
"success": true,
"message": "All Agents with users fetched successfully",
"data": [
{
"id": 101,
"user": {
"id": 1,
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"organization": 5
},
"agent_type": {
"id": 2,
"created_by": "System",
"created_on": "2024-01-01T00:00:00Z",
"modified_by": "admin@example.com",
"modified_on": "2024-01-02T00:00:00Z",
"name": "Chatbot",
"description": "Basic chatbot functionality"
},
"instructions": [
{
"id": 201,
"instruction": "Provide detailed responses.",
"is_deleted": false,
"created_by": "user@example.com",
"created_on": "2025-01-01T12:00:00Z",
"agent": 101
}
],
"project": {
"id": 10,
"project_name": "Sample Project",
"team": {
"id": 20,
"team_name": "Development Team"
}
},
"agent_name": "Support Assistant",
"industry_area": "Technology",
"domain": "Customer Support",
"sample_q1": "How can I reset my password?",
"sample_q2": "What is the status of my order?",
"sample_q3": "Can you provide technical support?",
"prefix_prompt": "Assist users with queries promptly.",
"alias": "support-assistant@company.com",
"is_active": true,
"is_deleted": false,
"created_by": "user@example.com",
"created_on": "2025-01-01T12:00:00Z",
"agent_image": "base64_encoded_image_string",
"access": "Only me",
"status": "Live",
"caching_enabled": false,
"chunk_count": 32,
"react_enabled": true,
"react_max_iteration_count": 50,
"llm_config": 1,
"cloned_from": null,
"summary": "This assistant handles customer support inquiries for the technology domain.",
"notes": "This is a demo agent for customer support.",
"training_progress": {
"status": "Complete",
"progress": 100
},
"training_data_updated": true,
"training_data_last_updated_on": "2025-01-15T08:00:00Z"
}
]
}
Request
None