Unpin Agent Response

DELETE

/v2/api/agent-response/{agent_response_id}/pin

The Unpin Agent Response API allows users to remove the pinned status from a specific agent response. Once unpinned, the response will no longer be highlighted and will behave as a normal response in the system.

How This Endpoint Works

Requires agent_response_id as a path parameter to identify the response to be unpinned.

Removes the pinned status, making the response appear as a normal response.

Useful for decluttering important responses and keeping only the most relevant ones pinned.

Purpose of Unpinning an Agent Response

Organize Responses: Unpin outdated or no longer relevant responses.

Refine AI Output: Keep only high-value responses pinned while managing knowledge efficiently.

How to View Agent Response ID

If you're unsure about the agent_response_id you need to unpin, follow this guide:
How to View Agent Response ID

Once unpinned, the response will return to its normal status and will no longer be marked as important in the system.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Agent response successfully unpinned.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Response unpinned successfully",
    "data": {
        "agent_response_id": 2,
        "pinned": false
    }
}

Pin Agent Response

Get Pinned Agent Responses

Unpin Agent Response

How This Endpoint Works#

Purpose of Unpinning an Agent Response#

How to View Agent Response ID#

Request

Responses

How This Endpoint Works

Purpose of Unpinning an Agent Response

How to View Agent Response ID