Annotate an Agent with Tags

POST

/v2/api/agent/{agent_id}/annotate

Overview

This endpoint allows clients to annotate an agent by assigning or removing descriptive tags. Tags help categorize and organize agents for improved filtering, search, and management.

Functionality

Tag Assignment:

Use the add_tags array to assign one or more new tags to the specified agent.

Tag Removal:

Use the remove_tags array to remove one or more existing tags from the agent.

Selective Tag Management:

You can use either add_tags, remove_tags, or both, depending on whether you want to add new tags, remove old ones, or perform both operations in a single request.

Path Parameter:

Requires the agent_id path parameter to identify the specific agent being updated.

How to Find Your Agent ID

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

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Agent tags updated successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/agent/0/annotate' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "add_tags": [
        "Added Tags",
        "Removed Tags"
    ],
    "remove_tags": []
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent tags updated successfully",
    "data": {}
}

Get All Distinct Agent Tags

Create Agent Vote

Annotate an Agent with Tags

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID