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 Agent Response

GET
/v2/api/agent-response/{agent_response_id}
The **Get Agent Response ** API endpoint allows users to retrieve detailed information about a specific agent's response using its unique response ID. This endpoint is particularly useful for tracking and analyzing AI-generated responses within conversations.

Understanding Agent Response ID#

Every response generated by an agent in a conversation is assigned a unique Agent Response ID.
This ID helps in identifying, storing, and retrieving specific responses from past interactions.
It is essential for logging AI-generated responses, debugging, and reviewing historical conversations.

Purpose of Agent Response ID#

The Agent Response ID serves as a key reference for:
Retrieving past responses for analysis and debugging.
Tracking user-agent interactions for improving AI behavior.
Understanding conversation flow by linking user queries to agent replies.

How to View an Agent Response or Chat Log ID#

To learn how to access an Agent Response ID or Chat Log ID, follow this step-by-step guide:
View Agent Response / Chat Log ID Guide

API Response Details#

When you request an agent response using this endpoint, the API returns structured data, including:
User Query: The original question or request made by the user.
Agent Response: The AI-generated reply to the user's query.
Timestamp: The exact time when the response was created.
User ID: Identifies which user submitted the query.
Comments & Feedback: Any feedback provided by the user about the response.

Complete Guide on Viewing Agent Responses & Chat Logs#

For a comprehensive guide on agent responses and chat logs, refer to:
Complete Guide on Agent Responses & Chat Logs

Request

Path Params

Header Params

Responses

🟢200OK
application/json
Agent response details retrieved successfully.
Body

🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///v2/api/agent-response/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '
Response Response Example
200 - Example 1
{
    "success": true,
    "message": "Agent Response Found Successfully.",
    "data": {
        "id": 10932,
        "comments": [
            {
                "comment": "Testing comment",
                "created_by": "[email protected]",
                "created_on": "2025-01-28T21:30:17.368939Z"
            }
        ],
        "feedback": [
            {
                "is_upvote": true,
                "is_downvote": false
            }
        ],
        "question": "Can you tell me how RAG works from the sources given?",
        "response": {
            "query": "Explain how Retrieval-Augmented Generation (RAG) works.",
            "answer": "Retrieval-Augmented Generation (RAG) is a technique in natural language processing that enhances the capabilities of generative language models by integrating real-time data retrieval. This approach addresses the limitations of traditional generative models, which rely solely on their training data and may produce outdated or incorrect information if the data is not current. RAG ensures that the responses generated are both contextually appropriate and grounded in factual information by incorporating real-time data from external sources.\n",
            "run_id": "4c0c5eb6-1902-4b26-97f3-448bcb7ba31f",
            "history": [
                {
                    "bot": "Retrieval-Augmented Generation (RAG) is a technique in natural language processing that enhances the capabilities of generative language models by integrating real-time data retrieval.\n",
                    "user": "Can you tell me how RAG works from the sources given?"
                }
            ],
            "indexes": [],
            "sources": "[0]",
            "success": true,
            "cache_hit": false,
            "agent_mode": "",
            "corpus_ids": [
                645
            ],
            "references": [
                {
                    "url": "Introduction_to_RAG1738098993.txt",
                    "order": 1,
                    "number": 0
                }
            ],
            "instructions": [],
            "total_tokens": 4757,
            "prompt_prefix": "",
            "prompt_tokens": 4277,
            "completion_tokens": 480,
            "followup_questions": [
                "How does RAG ensure responses are contextually appropriate?",
                "What role does the retriever play in the RAG process?",
                "Why is RAG beneficial for real-time information synthesis?"
            ]
        },
        "created_by": "[email protected]",
        "created_on": "2025-01-28T21:18:06.614958Z",
        "is_deleted": false,
        "total_tokens": 4757,
        "prompt_tokens": 4277,
        "completion_tokens": 480,
        "cache_hit": false,
        "query_source": "web",
        "message_id": null,
        "cost": "0.02379",
        "chat_thread": 4354,
        "agent": 952,
        "user": 1,
        "llm_config": 8
    }
}
Previous
Get Agent Responses By Chat Thread
Next
Delete Agent Response
Built with