Delete Agent Alias

DELETE

/v2/api/agent/{agent_id}/alias

Overview

This endpoint allows you to delete the alias associated with a specific agent based on the provided agent_id. Once the alias is successfully deleted, the response will return the updated list of remaining agent aliases along with their associated project details. This helps in keeping the alias records clean and up-to-date.

Functionality

Delete Alias: Deletes the alias associated with the provided agent ID.

Clean Listing: After deletion, it returns a fresh list of all remaining aliases.

Project Insight: Each remaining alias includes metadata about its associated project.

How to Find Your Agent ID

If you're unsure about the agent_id, follow this guide:
How to View Agent ID

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///v2/api/agent/1216/alias' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Alias Deleted successfully",
    "data": [
        {
            "id": 1469,
            "agent_name": "VocabChecker",
            "alias": "VocabChecker_1469-dev@ejento.ai",
            "project": {
                "id": 372,
                "created_by": "user@example.com",
                "created_on": "2025-01-30T20:20:55.902432Z",
                "modified_by": "",
                "modified_on": "2025-01-30T20:20:55.902453Z",
                "project_name": "userTestProject1",
                "team_visibility": false,
                "is_deleted": false,
                "team": 243
            }
        }
    ]
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Agent alias deleted successfully.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Update Agent Alias

Get Agent Access

Delete Agent Alias

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID