Ejento APIs
V2 Legacy
  • Stable
  • V2
  • V2 Legacy
  1. Agent Response
Ejento APIs
V2 Legacy
  • Stable
  • V2
  • V2 Legacy
  • Overview
  • Endpoints
    • Agent
      • Create Agent By Agent Builder
      • Create Agent By Configure
      • Get All Agents
      • Get Agent By Team
      • Get Agent By User Team
      • Agent Filtered
      • Get Agent
      • Edit Agent
      • Get Recent Agents
      • Create Recent Agent
      • Delete Recent Agent
      • Get Starred Agents
      • Create Starred Agent
      • Delete Starred Agent
    • Agent Corpus Connection
      • Create Agent Corpus Connection
      • Get Agent Corpus Connection
      • Edit Agent Corpus Connection
      • Delete Agent Corpus Connection
      • Get All Agent Corpus Connections
      • Delete All Agent Corpus Connections
    • Agent Response
      • Create Agent Response
        POST
      • Get All Agent Responses
        GET
      • Get Agent Responses By User
        GET
      • Get Agent Responses By Project
        GET
      • Get Agent Responses By Chat Thread
        GET
      • Get Agent Response
        GET
      • Delete Agent Response
        DELETE
      • Create Agent Response Comment
        POST
      • Get Agent Response Comment
        GET
      • Get Agent Response Dashboard
        POST
      • Create Agent Response Feedback
        POST
      • Create Agent Response Log
        POST
      • Pin Agent Response
        PUT
      • Unpin Agent Response
        DELETE
      • Get Pinned Agent Responses
        GET
    • Agent Reviews
      • Create Review
      • Get All Reviews
      • Get Reviews by Agent
      • Delete Review
    • Agent Rating
      • Get All Agent Ratings
      • Get Agent Rating
      • Update Agent Rating
    • Agent Alias
      • Get All Agent Aliases
      • Create Agent Alias
      • Update Agent Alias
      • Delete Agent Alias
    • Agent Access
      • Get Agent Access
      • Update Agent Access
    • Agent Type
      • Get All Agent Types
      • Get Agent Type
      • Update Agent Type
    • Agent User
      • Add Users to Agent
      • Get Users Of Agent
      • Delete User from Agent
      • Get User Agent Permission
      • Get All Agents with Users
    • Agent Tags
      • Get All Distinct Agent Tags
      • Annotate an Agent with Tags
    • Agent Vote
      • Create Agent Vote
      • Get Agent Vote
    • Agent Comment
      • Create Comment on an Agent
      • Get Comments for an Agent
      • Edit Agent Comment
    • Chat Thread
      • Create Chat Thread
      • Get All Chat Threads Of An Agent
      • Get All Chat Threads With Admin Panel Filters And Pagination
      • Get Reduced Chatlogs by Thread ID for Admin Panel
      • Get Chat Thread
      • Edit Chat Thread
      • Delete Chat Thread
      • Add ChatThread-Corpus Connection
      • Get ChatThread-Corpus Connection
      • Delete ChatThread-Corpus Connection
    • Project
      • Create Project
      • Get All Projects
      • Project Filtered
      • Get All Agents Of Project
      • Get All Projects By Team
      • Get Project
      • Edit Project
      • Delete Project
      • Fetch Project Details
      • Add Recent Project
      • Get Recent Projects
    • User Project
      • Add Users To Project
      • Get All Projects By User Teams
      • Get Projects By User and Team
      • Delete Users from Project
    • Document
      • Get Document
      • Edit Document
      • Add Or Remove Tags On Document
      • Document Polling
      • Trigger a refresh(reindex) of a Document
    • Corpus
      • Create Corpus
      • Get All Corpus
      • Get Corpus
      • Edit Corpus
      • Delete Corpus
      • Create Document In Corpus
      • Get All Documents From Corpus
      • Delete Document(s) from Corpus
      • Check Duplicate Documents
      • Get All Agents By Corpus
      • Get Corpus Permissions
      • Get Corpus Permission By User
      • Annotate Corpus
      • Trigger a refresh(reindex) of a Corpus
    • Notification
      • Create Notification
      • Retrieve All Notifications
      • Read Notifications By User ID
      • Retrieve Notification
      • Read Notification
      • Delete Notification
    • Feature Flag
      • Get All Feature Flags
      • Get DALL-E Feature Flag
      • Get Share Agent Feature Flag
      • Get Agent Alias Feature Flag
      • Get SharePoint Index Feature Flag
      • Get Chat Agent Creation Feature Flag
      • Get OAuth Feature Flags
      • Get Google OAuth Feature Flag
      • Get LinkedIn OAuth Feature Flag
      • Get MS SSO OAuth Feature Flag
      • Get Github OAuth Feature Flag
    • Team
      • Create Team
      • Get All Teams
      • Get Team Details
      • Edit Team
      • Delete Team
      • Create Recent Team
      • Get Recent Teams
      • Add Users to Team
      • Get Users in a Team
      • Get Teams Of User
      • Get User Role By Team
      • Get Agents Of User Team
      • Get Projects And Team
    • User
      • Create User In Organization
      • Get All Users By Organization
      • Get User
      • Edit User
      • Delete User
      • Batch Delete Users
      • User Filtered
      • Create User Permission
      • Get User Permission
      • Edit User Permission
      • Delete User Permission
    • Email Indexing Authorization
      • Email Authorize
    • Conversation Starters
      • Create Conversation Starter
      • Get Conversation Starters
    • Tool
      • Create Tool
      • Get All Tools
      • Get Tool
      • Edit Tool
      • Delete Tool
    • Agent Tool Connection
      • Enable Agent Tool
      • Get All Agent Tools
      • Disable Agent Tool
    • Organization Tool
      • Enable Organization Tool
    • API Tool Template
      • Create API Tool Template
      • Get All API Tool Templates
    • LLM Config
      • Get All LLM Configs
      • Get Active Config
      • Get LLM Config
      • Get Model Deployment
      • Get Org Configs
      • Set Agent Config View
  1. Agent Response

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

Path Params

Header Params

Responses

🟢200OK
application/json
Pinned agent responses retrieved successfully.
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request 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 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": "[email protected]",
            "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
        }
    ]
}
Previous
Unpin Agent Response
Next
Create Review
Built with