Get All Agent Types

GET

/v2/api/agent/type

Overview

This endpoint retrieves a complete list of all available agent types in the system. Each agent type represents a specific behavior, role, or functionality that an AI agent can perform (e.g., Tutor, QnA).

Purpose

Enables users and admins to understand and select appropriate types when creating or modifying agents.

Useful for displaying categorized agent types in the UI.

Request

Header Params

Responses

🟢200OK

application/json

Successfully fetched agent type data.

Body

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Type Data fetched successfully",
    "data": [
        {
            "id": 2,
            "created_by": "System",
            "created_on": "2024-04-17T23:10:22.316057Z",
            "modified_by": "[email protected]",
            "modified_on": "2024-04-17T23:10:22.316074Z",
            "name": "Tutor",
            "description": null
        }
    ]
}

Update Agent Access

Get Agent Type

Get All Agent Types

Overview#

Purpose#

Request

Responses

Overview

Purpose