Get Pinned Agent Responses

GET

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

Agent Response

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

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": [
                    null
                ],
                "sources": "",
                "success": true,
                "thoughts": "",
                "cache_hit": false,
                "agent_mode": "QnA",
                "corpus_ids": [
                    1739,
                    1143,
                    1226,
                    1227
                ],
                "references": [
                    null
                ],
                "data_points": [
                    null
                ],
                "instructions": [
                    null
                ],
                "total_tokens": 0,
                "prompt_prefix": "abc",
                "prompt_tokens": 0,
                "completion_tokens": 0,
                "followup_questions": [
                    null
                ]
            },
            "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

agent_id

integer

required

The unique identifier of the agent whose pinned responses need to be retrieved.

Example:

1297

Responses

🟢200OK

application/json

Pinned agent responses retrieved successfully.

Body

success

boolean

optional

Indicates if the request was successful.

Example:

true

message

string

optional

Confirmation message for successful retrieval.

Example:

Pinned chat logs retrieved successfully

data

array [object {10}]

optional

List of pinned responses.

integer

optional

Unique identifier of the pinned response.

Example:

25050

question

string

optional

The user's question.

Example:

response

object

optional

The agent's response details.

created_by

string <email>

optional

Email of the user who created the response.

Example:

hamza.nasir@example.com

created_on

string <date-time>

optional

Timestamp when the response was created.

Example:

2025-04-03T20:07:52.200863+00:00

total_tokens

integer

optional

Total number of tokens used in the interaction.

Example:

prompt_tokens

integer

optional

Number of tokens used in the prompt.

Example:

completion_tokens

integer

optional

Number of tokens used in the completion.

Example:

pinned

boolean

optional

Indicates whether the response is pinned.

Example:

true

chat_thread_id

integer

optional

The chat thread ID associated with the response.

Example:

6628

🟠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