Create Comment on an Agent

POST

/v2/api/agent/{agent_id}/comment

Agent Comment

Overview

This endpoint enables authenticated users to post a new comment on a specific agent. The submitted comment is stored along with metadata such as the submitting user's information, the agent's details, and the timestamp of submission.

Functionality

Agent Targeting:

Requires the agent_id to be provided in the URL path to identify the agent on which the comment is being posted.

Request Requirements:

Accepts a JSON payload containing the comment field (mandatory), which holds the textual content of the comment.

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 --request POST '/v2/api/agent//comment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "hey, I am testing comment"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "Comment created successfully",
    "data": {
        "id": 24,
        "user": {
            "id": 16,
            "email": "user@example.com",
            "is_staff": true,
            "is_superuser": true,
            "is_active": true,
            "date_joined": "2024-01-30T17:23:41.663281Z",
            "first_name": "user",
            "last_name": "user",
            "organization": {
                "id": 1,
                "org_name": "Data Science Dojo",
                "domain": "datasciencedojo.com",
                "description": "",
                "org_logo_url": null,
                "org_icon_url": null,
                "is_deleted": false,
                "created_by": "System",
                "created_on": "2024-01-20T01:32:56.659642Z",
                "modified_by": "user@example.com",
                "modified_on": "2024-01-20T01:32:56.659663Z"
            }
        },
        "comment": "hey, I am testing comment",
        "submit_date": "2025-04-02T20:56:16.332786Z",
        "is_public": true,
        "is_removed": false,
        "agent": {
            "id": 1297,
            "agent_name": "FC Barca"
        }
    }
}

Request

Path Params

agent_id

integer

required

The unique ID of the agent for which the comment is being posted.

Example:

1297

Body Params application/json

comment

string

required

The content of the comment to be posted.

Example:

hey, I am testing comment

Examples

Responses

🟢201Created

application/json

Comment created successfully.

Body

success

boolean

optional

Indicates if the comment was successfully created.

Example:

true

message

string

optional

Confirmation message.

Example:

Comment created successfully

data

object

optional

Contains the details of the created comment.

integer

optional

The unique ID of the created comment.

Example:

user

object

optional

Information about the user who posted the comment.

comment

string

optional

The content of the comment.

Example:

hey, I am testing comment

submit_date

string <date-time>

optional

The timestamp when the comment was submitted.

Example:

2025-04-02T20:56:16.332786Z

is_public

boolean

optional

Indicates if the comment is publicly visible.

Example:

true

is_removed

boolean

optional

Indicates if the comment has been removed.

Example:

false

agent

object

optional

Details of the agent on whom the comment is posted.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Get Agent Vote

Get Comments for an Agent

Create Comment on an Agent

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID