Get agent history with pagination
GET
/api/v2/agents/{agent_id}/history
page (int): Page number for pagination (default: 1)
items_per_page (int): Number of items per page (default: 10)
verbosity (str): Response detail level. 'low' returns lightweight items (history_id, history_date, modified_by)
similar to revision-history; 'high' returns full history records (default: high).
Request
Path Params
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https:///api/v2/agents//history?items_per_page=&page=&verbosity=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Success Response
{
"success": true,
"message": "Agent history fetched successfully",
"data": {
"history_records": [
{
"history_id": 1,
"history_date": "2024-03-20T10:00:00Z",
"agent_name": "Test Agent",
"domain": "Test Domain",
"sample_q1": "Sample Question 1",
"sample_q2": "Sample Question 2",
"sample_q3": "Sample Question 3",
"sample_q4": "Sample Question 4",
"prefix_prompt": "Test prefix prompt",
"access": "Public",
"status": "Live",
"agent_type": {
"id": 1,
"name": "QnA"
},
"llm_config": {
"id": 47,
"model_deployment": "gpt-4.1",
"model_name": "GPT 4.1",
"is_enabled": true,
"is_default": false
},
"voice_llm_config": {
"id": 48,
"model_deployment": "gpt-realtime",
"model_name": "gpt-realtime",
"is_enabled": true,
"is_default": false
},
"caching_enabled": true,
"is_published_as_teammate": false,
"pattern": {
"id": 1,
"name": "ReAct",
"description": "ReAct reasoning pattern"
},
"call_enabled": true,
"character_voice": {
"id": 12,
"voice_name": "Jenny",
"voice_identifier": "en-US-JennyNeural",
"gender": "female"
},
"agent_image": "https://example.com/agent-image.jpg",
"instructions": [
"instruction1",
"instruction2"
],
"tools": [
"tool1",
"tool2"
],
"tags": [
"tag1",
"tag2",
"tag3"
],
"modified_by": "[email protected]"
}
],
"total_records": 1,
"current_page": 1,
"total_pages": 1
}
}