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.

Query Parameters:

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

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

query_source: To determine source of the agent response. Default is "web".

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

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

Returns:

JsonResponse with the retrieved agent response objects or error message.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/agents//responses' \
--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,
                "comments": [
                    {
                        "comment": "string",
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22Z"
                    }
                ],
                "feedback": [
                    {
                        "is_upvote": true,
                        "is_downvote": true
                    }
                ],
                "response_steps": [
                    {
                        "id": 0,
                        "response_log": 0,
                        "type": "string",
                        "name": "string",
                        "content": {
                            "property1": null,
                            "property2": null
                        },
                        "friendly_message": "string",
                        "created_on": "2019-08-24T14:15:22Z"
                    }
                ],
                "question": "string",
                "response": {
                    "property1": null,
                    "property2": null
                },
                "created_by": "string",
                "created_on": "2019-08-24T14:15:22Z",
                "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_thread": 0,
                "agent": 0,
                "user": 0,
                "llm_config": 0
            }
        ]
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get Agent Responses based on filters

Create Agent Response Log