Create Agent Response Comment

POST

/v2/api/agent-response/{agent_response_id}/comment

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.

How This Endpoint Works

Users can attach a comment to an agent’s response using the agent_response_id as a path parameter.

The comment is included in the request body, allowing detailed feedback on AI-generated responses.

Useful for refining AI performance, tracking response accuracy, and storing user insights.

How to View Agent Response ID

To find the Agent Response ID required for commenting, refer to this guide:
View Agent Response / Chat Log ID Guide

Complete Guide on Managing Agent Responses & Comments

For a more detailed overview of agent responses, chat logs, and feedback management, visit:
Complete Guide on Agent Responses & Chat Logs

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/agent-response/2/comment' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "Hz8 Testing comment"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Comment Created Successfully!",
    "data": {
        "id": 2,
        "comments": [
            {
                "comment": "Hz8 Testing comment",
                "created_by": "function-app@ejento.ai",
                "created_on": "2025-03-24T03:12:53.923684Z"
            }
        ],
        "feedback": [],
        "question": "Write some test cases in python to automate   by authenticating first as a user with some credentials",
        "response": {
            "query": "'Python test cases for API authentication with user credentials'",
            "answer": "Sorry, couldn't find the answer in the provided documents.",
            "indexes": [],
            "sources": "",
            "cache_hit": false,
            "references": [],
            "total_tokens": 1538,
            "prompt_tokens": 727,
            "completion_tokens": 811,
            "followup_questions": [
                "",
                "",
                ""
            ]
        },
        "created_by": "sshaikh@example.com",
        "created_on": "2024-01-20T03:53:07.848919Z",
        "is_deleted": false,
        "total_tokens": 1538,
        "prompt_tokens": 727,
        "completion_tokens": 811,
        "cache_hit": false,
        "query_source": "web",
        "message_id": null,
        "cost": "0.00769",
        "pinned": false,
        "chat_thread": 2,
        "agent": 17,
        "user": 2,
        "llm_config": 8
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Comment successfully added to the agent response.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Delete Agent Response

Get Agent Response Comment

Create Agent Response Comment

How This Endpoint Works#

How to View Agent Response ID#

Complete Guide on Managing Agent Responses & Comments#

Request

Responses

How This Endpoint Works

How to View Agent Response ID

Complete Guide on Managing Agent Responses & Comments