Get an Agent Response

GET

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

This endpoint allows users to retrieve detailed information about a specific agent's response using its unique response ID.
This endpoint is particularly useful for tracking and analyzing AI-generated responses within conversations.

Query Parameters:

all_sources (bool): Whether to retrieve from all sources (default is 'False')

response_type (str): Can be 'supporting_content', 'thought_process', or omitted

Returns:

A response containing the retrieved agent response

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

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/?all_sources=&response_type=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - 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
    }
}

Generate Token for Voice Call

Update an Agent Response