Get Agent
GET
/v2/api/agent/{agent_id}
agent_id.This endpoint is essential for fetching an agent’s complete configuration, settings, and metadata.
Purpose of This Endpoint
Required Parameter
agent_id (string, required) – The unique identifier of the agent whose details need to be fetched.What is an Agent ID?
It helps differentiate between multiple agents and enables precise API calls for retrieving, managing, or interacting with them.
Purpose of Agent ID
How to View Your Agent ID?
View Your Agent ID
Related API Endpoints
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///v2/api/agent/1297' \
--header 'Ocp-Apim-Subscription-Key;'Response Response Example
{
"success": true,
"message": "All Agent data fetched successfully",
"data": {
"id": 1297,
"user": {
"id": 147,
"email": "user@example.com",
"first_name": "User",
"last_name": "User",
"organization": 1
},
"agent_type": {
"id": 1,
"created_by": "System",
"created_on": "2024-04-17T23:10:22.313394Z",
"modified_by": "user@example.com",
"modified_on": "2024-04-17T23:10:22.313414Z",
"name": "QnA",
"description": ""
},
"instructions": [
{
"id": 10611,
"instruction": "",
"is_deleted": false,
"created_by": "user@example.com",
"created_on": "2025-01-29T17:23:00.550155Z",
"agent": 1297
}
],
"connected_tool_names": [
"Rag Tool",
"Attachment Tool"
],
"tags": [],
"agent_name": "FC Barcelona Info Assistant",
"industry_area": "",
"domain": "Your go-to assistant for everything related to FC Barcelona! Get real-time updates, match details, player stats, transfer news, and historical insights about the club",
"sample_q1": "",
"sample_q2": "",
"sample_q3": "",
"prefix_prompt": "",
"alias": "FCBarcelonaInfoAssistant_1297-dev@ejento.ai",
"is_active": false,
"is_deleted": false,
"created_by": "user@example.com",
"created_on": "2025-01-29T17:23:00.299537Z",
"agent_image": "[object Object]",
"access": "Public",
"status": "Live",
"caching_enabled": false,
"chunk_count": 32,
"react_enabled": true,
"react_max_iteration_count": 50,
"project": 254,
"llm_config": 8,
"cloned_from": null
}
}Request
Path Params
Header Params