Get Agent Responses By Project

The Get Agent Responses By Project API endpoint retrieves all agent responses associated with a specific project. This allows project owners and teams to review agent interactions, analyze response patterns, and monitor performance within the context of a particular project.

How This Endpoint Works

Requires the project_id as a path parameter to fetch responses related to a specific project.

Returns a structured list of all agent responses tied to the project, helping in AI response evaluation and improvement.

Supports filtering and analyzing responses for better project insights.

What is a Project ID?

A Project ID is a unique identifier assigned to each project within the system. It helps in organizing and managing agent interactions within a specific project environment.

How to View Your Project ID

If you need to find your project_id, refer to this guide:
How to View Your Project ID

This API is essential for tracking agent interactions within a project, ensuring quality control, and enhancing AI-driven workflows.

{ "success": true, "message": "Agent Response Found Successfully.", "data": { "count": 191, "num_pages": 96, "current_page": 2, "agent_responses": [ { "id": 101, "comments": [ "string" ], "feedback": [ "string" ], "agent": { "id": 5, "agent_name": "Support Bot", "agent_type": { "name": "QnA" }, "created_by": "admin@example.com", "created_on": "2024-11-12T01:48:44.959126Z", "agent_image": "https://example.com/default-agent.png", "user": 3, "project": 2 }, "question": "Hello, how can I reset my password?", "response": { "query": "Hello, how can I reset my password?", "answer": "You can reset your password by clicking 'Forgot Password' on the login page.", "references": [ "string" ], "agent_mode": "QnA" }, "created_by": "user@example.com", "created_on": "2025-01-02T21:55:50.071072Z", "query_source": "web", "user": 4, "chat_thread": 3 } ] } }

Request

Path Params

project_id

integer

required

The unique ID of the project whose agent responses are to be fetched.

Query Params

query_source

string

optional

Filter responses by query source.

items_per_page

integer

optional

Number of items per page.

page

integer

optional

Page number for pagination.

Responses

🟢200OK

application/json

Agent responses found successfully

Body

success

boolean

optional

Example:

true

message

string

optional

Example:

Agent Response Found Successfully.

data

object

optional

count

integer

optional

Example:

191

num_pages

integer

optional

Example:

current_page

integer

optional

Example:

agent_responses

array [object {11}]

optional

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get Agent Responses By Project

How This Endpoint Works#

What is a Project ID?#

How to View Your Project ID#

Request

Responses

How This Endpoint Works

What is a Project ID?

How to View Your Project ID