Get All Agents

GET

/v2/api/agent

The Get All Agents API endpoint is designed to retrieve a structured list of all agents
currently registered in the system. It provides comprehensive metadata about each agent,
including type, ownership details, project association, and key configurations
that define the agent’s behavior.

Purpose of This Endpoint

Allows admins and users to view and manage all agents in the system.

Helps monitor and organize agents based on ownership, project, or team.

Useful for auditing, tracking configurations, and managing agent assignments.

Provides an overview of agent properties for better system governance.

To get details of a specific agent, use the Get Agent endpoint.

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

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

Request

Header Params

Responses

🟢200OK

application/json

Successfully retrieved the list of agents.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "All agents fetched successfully.",
    "data": [
        {
            "id": 1335,
            "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": 10973,
                    "instruction": "",
                    "is_deleted": false,
                    "created_by": "[email protected]",
                    "created_on": "2025-02-14T02:59:55.974883Z",
                    "agent": 1335
                }
            ],
            "user": {
                "id": 1,
                "email": "[email protected]",
                "first_name": "Ejento",
                "last_name": "Admin",
                "organization": 1
            },
            "project": {
                "id": 389,
                "project_name": "API Testing Project",
                "team": {
                    "id": 63,
                    "team_name": "pla"
                }
            },
            "knowledge_base_available": false,
            "connected_tool_names": [
                "Rag Tool"
            ],
            "agent_name": "New Assistant",
            "industry_area": "",
            "domain": "",
            "sample_q1": "",
            "sample_q2": "",
            "sample_q3": "",
            "prefix_prompt": "",
            "alias": "[email protected]",
            "is_active": true,
            "is_deleted": false,
            "created_by": "[email protected]",
            "created_on": "2025-02-13T23:19:09.408048Z",
            "agent_image": "[object Object]",
            "access": "Only me",
            "status": "Live",
            "caching_enabled": false,
            "chunk_count": 32,
            "react_enabled": true,
            "react_max_iteration_count": 50,
            "llm_config": 8,
            "cloned_from": null
        }
    ]
}

Create Agent By Configure

Get Agent By Team

Get All Agents

Purpose of This Endpoint#

Related API Endpoints#

Request

Responses

Purpose of This Endpoint

Related API Endpoints