Get Pinned Agent Responses

GET

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

Retrieve all responses that have been manually pinned for a specific agent by using unique agent_id of the agent.
This endpoint is ideal for accessing significant interactions,
typically marked for review, analytics, or frontend display in chat applications.

Viewing Your Agent ID

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

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/agent/0/response/pin' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "Pinned chat logs retrieved successfully",
    "data": [
        {
            "id": 25050,
            "question": "..",
            "response": {
                "query": "",
                "answer": "It seems like your query is incomplete or unclear. Could you please provide more context or specify what you're looking for? This will help me assist you effectively.",
                "run_id": "44905345-ddae-4390-98a5-a1c1e6bc98b5",
                "history": [
                    {
                        "bot": "It seems like your query is incomplete or unclear...",
                        "user": ".."
                    }
                ],
                "indexes": [
                    "string"
                ],
                "sources": "",
                "success": true,
                "thoughts": "",
                "cache_hit": false,
                "agent_mode": "QnA",
                "corpus_ids": [
                    1739,
                    1143,
                    1226,
                    1227
                ],
                "references": [
                    "string"
                ],
                "data_points": [
                    "string"
                ],
                "instructions": [
                    "string"
                ],
                "total_tokens": 0,
                "prompt_prefix": "abc",
                "prompt_tokens": 0,
                "completion_tokens": 0,
                "followup_questions": [
                    "string"
                ]
            },
            "created_by": "hamza.nasir@example.com",
            "created_on": "2025-04-03T20:07:52.200863+00:00",
            "total_tokens": 0,
            "prompt_tokens": 0,
            "completion_tokens": 0,
            "pinned": true,
            "chat_thread_id": 6628
        }
    ]
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Pinned agent responses retrieved successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Unpin Agent Response

Create Review

Get Pinned Agent Responses

Viewing Your Agent ID#

Request

Responses

Viewing Your Agent ID