Get Agent Responses using Project ID

GET

/api/v2/projects/{project_id}/agent-responses

Retrieves Agent Responses associated with a specific project.

Path Parameters:

project_id (int): The ID of the project to retrieve agent responses for.

Query Parameters:

query_source (str): The source of the query. Default is "web".

items_per_page (int): The number of items per page. Default is 50.

page (int): The page number. Default is 1.

Returns:

A response containing the retrieved agent response objects.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/projects//agent-responses' \
--header 'Ocp-Apim-Subscription-Key;'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "count": 0,
        "num_pages": 0,
        "current_page": 0,
        "agent_responses": [
            {
                "id": 0,
                "comments": [
                    {
                        "id": 0,
                        "comment": "string",
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22Z",
                        "chat_log": 0
                    }
                ],
                "feedback": [
                    {
                        "id": 0,
                        "created_by": "string",
                        "created_on": "2019-08-24T14:15:22Z",
                        "modified_by": "string",
                        "modified_on": "2019-08-24T14:15:22Z",
                        "is_upvote": true,
                        "is_downvote": true,
                        "chat_log": 0
                    }
                ],
                "agent": {
                    "id": 0,
                    "agent_name": "string",
                    "agent_type": {
                        "name": "string"
                    },
                    "created_by": "string",
                    "created_on": "2019-08-24T14:15:22Z",
                    "agent_image": "string",
                    "user": 0,
                    "project": 0
                },
                "question": "string",
                "response": {
                    "property1": null,
                    "property2": null
                },
                "created_by": "string",
                "created_on": "2019-08-24T14:15:22Z",
                "query_source": "string",
                "user": 0,
                "chat_thread": 0
            }
        ]
    }
}

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Successfully retrieved agent responses

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Delete a Project

Add a Recent Project for a User