Get All Agent Aliases

GET

/v2/api/agent/alias

Overview

This endpoint retrieves a list of all agent aliases, providing detailed information about each alias along with the associated project. Each alias is associated with an agent, and for each agent alias, you will get details about the respective project it is linked to. This is useful when you want to view all aliases for agents in a particular system or project.

Functionality

Fetch All Agent Aliases: The primary purpose of this endpoint is to retrieve all agent aliases.

Associated Project Information: For each alias, this endpoint provides details about the project associated with it, including project creation and modification details, project name, and team visibility.

Request

Header Params

Responses

🟢200OK

application/json

Successfully retrieved the agent aliases.

Body

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Alias Data fetched successfully",
    "data": [
        {
            "id": 1263,
            "agent_name": "New Assistant",
            "alias": "[email protected]",
            "project": {
                "id": 259,
                "created_by": "[email protected]",
                "created_on": "2025-01-03T22:42:59.798901Z",
                "modified_by": "",
                "modified_on": "2025-01-03T22:42:59.798919Z",
                "project_name": "Test",
                "team_visibility": false,
                "is_deleted": false,
                "team": 235
            }
        }
    ]
}

Update Agent Rating

Create Agent Alias

Get All Agent Aliases

Overview#

Functionality#

Request

Responses

Overview

Functionality