Vote on an Agent

POST

/api/v2/agents/{agent_id}/votes

Casts or clears a vote (upvote/downvote) on a specific agent.

Purpose:

Allows users to express positive or negative feedback on an agent.

Voting impacts agent metrics like like/dislike counts, typically used for ranking or analytics.

Path Parameters:

agent_id (int): ID of the Agent to cast a vote on.

Request Body (JSON):

vote (string): Acceptable values are:

"up" to upvote the agent.

"down" to downvote the agent.

"clear" to remove the user's previous vote.

Responses:

200 OK: Vote recorded or cleared successfully. Returns updated like and dislike counts.

400 Bad Request: If the version is invalid or the request body contains invalid data.

404 Not Found: If the agent ID is not found.

500 Internal Server Error: If any server-side error occurs during voting.

Notes:

Only one vote per user is allowed per agent; previous votes are overwritten.

Vote data is tracked using the Vote model and associated via Django's ContentType framework.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//votes' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "vote": "up"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "like_count": 0,
        "dislike_count": 0
    }
}

Get Vote Information for an Agent

Agent Type