Get Agent Responses of an Agent

GET

/api/v2/agents/{agent_id}/responses

Allows retrieving agent responses filtered by agent id. This endpoint supports pagination and filtering options.

Staging behaviour:

Pass agent_version=staging as a query parameter to retrieve responses for the staging version instead of the published agent's.

Query Parameters:

voted: To filter responses based on "upvote" or "downvote".

query: To filter responses based on some query/search words.

query_source: If provided, filter by source (e.g., "web"); otherwise include all sources by default.

include_evaluation: If true, include responses with query_source="evaluation". Default is false (evaluation responses are excluded).

items_per_page: To determine items to be retrieved per page. Default is 50.

page: To determine the page number. Default is 1.

include_responses_of_versions: When "true", responses from both the production and staging versions of the agent are returned together. Each item in the response includes an agent_version field ("production" or "staging"). Accepted values: "true", "false" (case-insensitive). Defaults to false.
Note: The counterpart agent's responses are only included if the requesting user has view access to that agent. If access is not granted, only the requested agent's responses are returned — no error is raised.

Returns:

JsonResponse with the retrieved agent response objects or error message.

Current Version:

2.1.0

Changelog:

2.1.0: Added include_responses_of_versions query parameter. When true, responses from both the production and staging versions of the agent are combined in a single response. Each response item includes an agent_version field ("production" or "staging").

2.0.0: Initial version.

Request

Path Params

Query Params

Header Params

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//responses?include_evaluation_queries=&include_responses_of_versions=&items_per_page=&page=&query=&query_source=&voted=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "message": "string",
    "success": true,
    "data": {
        "count": 0,
        "num_pages": 0,
        "current_page": 0,
        "agent_responses": [
            {
                "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": [
                    {
                        "comment": "string",
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22.123Z"
                    }
                ],
                "feedback": [
                    {
                        "is_upvote": true,
                        "is_downvote": true
                    }
                ],
                "response_steps": [
                    {
                        "id": 0,
                        "response_log": 0,
                        "type": "string",
                        "name": "string",
                        "content": {
                            "property1": "string",
                            "property2": "string"
                        },
                        "friendly_message": "string",
                        "created_on": "2019-08-24T14:15:22.123Z"
                    }
                ],
                "agent_version": "string",
                "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 Agent Responses based on filters

Create Agent Response Log