Get All Agent Responses

GET

/v2/api/agent/{agent_id}/response

Agent Response

The Get All Agent Responses API endpoint allows retrieving all responses generated by a specific agent. This includes detailed information about each response, enabling users to analyze past interactions, track engagement, and review feedback.

How This Endpoint Works

Requires the agent_id as a path parameter to specify which agent's responses should be retrieved.

Returns a structured list of all responses, including metadata, user queries, AI-generated replies, and feedback.

Useful for monitoring agent performance, analyzing common user queries, and improving AI responses.

Viewing Your Agent ID

If you need to find your agent_id, refer to this guide:
How to View Your Agent ID

Complete Guide on Managing Agent Responses

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/api/agent//response?query_source&items_per_page&page'

Response Example

{
    "success": true,
    "message": "Agent Response Found Successfully.",
    "data": {
        "count": 41,
        "num_pages": 5,
        "current_page": 1,
        "agent_responses": [
            {
                "id": 10921,
                "comments": [],
                "feedback": [],
                "question": "What is the overview of the approach combining a pre-trained retriever with a pre-trained seq2seq model?",
                "response": {
                    "query": "detailed overview of the method that integrates a pre-trained retrieval model with a pre-trained sequence-to-sequence (seq2seq) model",
                    "answer": "Sorry, I cannot find the answer in the available sources.",
                    "run_id": "92cc760c-6739-4ea0-b2cf-164c9b9ba074",
                    "history": [
                        {
                            "bot": "Sorry, I cannot find the answer in the available sources.",
                            "user": "What is the overview of the approach combining a pre-trained retriever with a pre-trained seq2seq model?"
                        }
                    ],
                    "indexes": [],
                    "sources": "",
                    "success": true,
                    "cache_hit": false,
                    "agent_mode": "",
                    "corpus_ids": [
                        645
                    ],
                    "references": [
                        {
                            "url": "example.pdf",
                            "order": 1,
                            "number": 0
                        }
                    ],
                    "instructions": [],
                    "total_tokens": 3384,
                    "prompt_prefix": "",
                    "prompt_tokens": 2633,
                    "completion_tokens": 751,
                    "followup_questions": []
                },
                "created_by": "user@example.com",
                "created_on": "2025-01-28T20:52:37.043472Z",
                "is_deleted": false,
                "total_tokens": 3384,
                "prompt_tokens": 2633,
                "completion_tokens": 751,
                "cache_hit": false,
                "query_source": "web",
                "message_id": null,
                "cost": "0.01692",
                "chat_thread": 4342,
                "agent": 952,
                "user": 1,
                "llm_config": 8
            }
        ]
    }
}

Request

Path Params

agent_id

integer

required

The ID of the agent for which responses are being retrieved.

Query Params

query_source

string

optional

Source of the query (e.g., 'web', 'mobile', etc.).

Example:

web

items_per_page

integer

optional

Number of items to return per page.

Example:

page

integer

optional

The page number of the results to retrieve.

Example:

Responses

🟢200OK

application/json

A list of all responses associated with the specified agent.

Body

success

boolean

optional

Example:

true

message

string

optional

Example:

Agent Response Found Successfully.

data

object

optional

count

integer

optional

Example:

num_pages

integer

optional

Example:

current_page

integer

optional

Example:

agent_responses

array [object {19}]

optional

Create Agent Response

Get Agent Responses By User

Get All Agent Responses

How This Endpoint Works#

Viewing Your Agent ID#

Complete Guide on Managing Agent Responses#

Request

Responses

How This Endpoint Works

Viewing Your Agent ID

Complete Guide on Managing Agent Responses