Create a Comment for Agent Response

POST

/api/v2/agent-responses/{agent_response_id}/comments

The Create Agent Response Comment API endpoint allows users to add a comment to a specific agent response.
This feature enables users to provide feedback, insights, or notes regarding an AI-generated response, improving conversation tracking and refining AI behavior.

Path Parameters:

agent_response_id (int): The ID of the agent response for which the comment is to be created.

Request Body:

comment (str): The comment to be added to the agent response.

Returns:

A response containing the agent response object including its newly created comment object.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201Created

application/json

Successfully created Agent Response Comment

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agent-responses//comments' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "comment": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "created_by": "string",
        "modified_by": "string",
        "created_on": "2019-08-24T14:15:22.123Z",
        "modified_on": "2019-08-24T14:15:22.123Z",
        "comments": [
            {
                "id": 0,
                "created_by": "string",
                "modified_by": "string",
                "created_on": "2019-08-24T14:15:22.123Z",
                "modified_on": "2019-08-24T14:15:22.123Z",
                "comment": "string",
                "parent": 0,
                "chat_log": 0
            }
        ],
        "feedback": [
            {
                "id": 0,
                "created_by": "string",
                "modified_by": "string",
                "created_on": "2019-08-24T14:15:22.123Z",
                "modified_on": "2019-08-24T14:15:22.123Z",
                "is_upvote": true,
                "is_downvote": true,
                "parent": 0,
                "chat_log": 0
            }
        ],
        "question": "string",
        "response": {
            "property1": "string",
            "property2": "string"
        },
        "is_deleted": true,
        "total_tokens": -2147483648,
        "prompt_tokens": -2147483648,
        "completion_tokens": -2147483648,
        "cache_hit": true,
        "query_source": "string",
        "message_id": "string",
        "cost": "string",
        "pinned": true,
        "guardrail_triggered": true,
        "chat_type": "text",
        "parent": 0,
        "chat_thread": 0,
        "agent": 0,
        "user": 0,
        "llm_config": 0
    }
}

Get Comments for Agent Response

Create a Feedback for an Agent Response