Get All Agents with Users

GET

/v2/api/agent/user

Retrieves a comprehensive list of all agents along with their associated user details.
Each agent entry includes metadata such as the agent type, assigned users, projects,
industry domain, and other relevant attributes.

Functionality:

Fetches all registered agents in the system.

Provides details of the users associated with each agent.

Includes agent-specific configurations such as caching, access settings,
and training progress.

Returns project details linked to the agent.

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

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

Request Example

Shell

JavaScript

Java

Swift

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

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

Header Params

Responses

🟢200OK

application/json

List of agents with associated user information fetched successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Get User Agent Permission

Get All Distinct Agent Tags