Create Agent Vote

POST

/v2/api/agent/{agent_id}/vote

Overview

This endpoint allows users to express feedback about a specific agent by casting a vote. The voting system supports upvotes, downvotes, and the option to clear a previous vote.

Functionality

Vote Types:

up: Registers a positive vote (upvote) for the agent.

down: Registers a negative vote (downvote) for the agent.

clear: Removes the user’s previous vote (whether up or down).

Path Parameter:

Requires the agent_id to specify which agent the vote should be applied to.

Request Body:

Must contain a valid vote value ("up", "down", or "clear").

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 POST 'https:///v2/api/agent/0/vote' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "vote": "up"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Successfully upvoted the agent",
    "data": {
        "like_count": 1,
        "dislike_count": 0
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Agent vote cast successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Annotate an Agent with Tags

Get Agent Vote

Create Agent Vote

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID