curl --request GET \
--url https://api.example.com/v1/voiceai/conversations/{conversation_id} \
--header 'x-api-key: <api-key>'{
"agent_id": "<string>",
"conversation_id": "<string>",
"status": "initiated",
"transcript": [
{
"role": "user",
"time_in_call_secs": 123,
"message": "<string>",
"interrupted": false,
"original_message": "<string>",
"source_medium": "audio",
"llm_override": "<string>",
"tool_calls": [
{
"request_id": "<string>",
"tool_name": "<string>",
"params_as_json": "<string>",
"tool_has_been_called": true,
"type": "system",
"tool_details": {
"type": "webhook",
"url": "<string>",
"method": "<string>"
}
}
],
"tool_results": [
{
"request_id": "<string>",
"tool_name": "<string>",
"result_value": "<string>",
"is_error": true,
"tool_has_been_called": true,
"tool_latency_secs": 0,
"dynamic_variable_updates": [
{
"variable_name": "<string>",
"old_value": "<string>",
"new_value": "<string>",
"updated_at": 123,
"tool_name": "<string>",
"tool_request_id": "<string>"
}
],
"type": "client"
}
],
"feedback": {
"score": "like",
"time_in_call_secs": 123
},
"conversation_turn_metrics": {
"metrics": {}
},
"rag_retrieval_info": {
"embedding_model": "gemini-embedding-001",
"retrieval_query": "<string>",
"rag_latency_secs": 123,
"chunks": [
{
"document_id": "<string>",
"chunk_id": "<string>",
"vector_distance": 123
}
]
},
"llm_usage": {
"model_usage": {}
},
"agent_metadata": {
"agent_id": "<string>",
"branch_id": "<string>",
"workflow_node_id": "<string>"
}
}
],
"metadata": {
"start_time_unix_secs": 123,
"call_duration_secs": 123,
"accepted_time_unix_secs": 123,
"cost": 123,
"charging": {
"dev_discount": false,
"is_burst": false,
"tier": "<string>",
"llm_usage": {
"irreversible_generation": {
"model_usage": {}
},
"initiated_generation": {
"model_usage": {}
}
},
"llm_price": 123,
"llm_charge": 123,
"call_charge": 123,
"free_minutes_consumed": 0,
"free_llm_dollars_consumed": 0
},
"deletion_settings": {
"deletion_time_unix_secs": 123,
"deleted_logs_at_time_unix_secs": 123,
"deleted_audio_at_time_unix_secs": 123,
"deleted_transcript_at_time_unix_secs": 123,
"delete_transcript_and_pii": false,
"delete_audio": false
},
"feedback": {
"type": "thumbs",
"overall_score": "like",
"likes": 0,
"dislikes": 0,
"rating": 123,
"comment": "<string>"
},
"authorization_method": "public",
"phone_call": {
"direction": "inbound",
"phone_number_id": "<string>",
"agent_number": "<string>",
"external_number": "<string>",
"call_sid": "<string>"
},
"batch_call": {
"batch_call_id": "<string>",
"batch_call_recipient_id": "<string>"
},
"termination_reason": "",
"error": {
"code": 123,
"reason": "<string>"
},
"warnings": [
"<string>"
],
"main_language": "<string>",
"rag_usage": {
"usage_count": 123,
"embedding_model": "<string>"
},
"text_only": false,
"features_usage": {
"language_detection": {
"enabled": false,
"used": false
},
"transfer_to_agent": {
"enabled": false,
"used": false
},
"transfer_to_number": {
"enabled": false,
"used": false
},
"multivoice": {
"enabled": false,
"used": false
},
"dtmf_tones": {
"enabled": false,
"used": false
},
"external_mcp_servers": {
"enabled": false,
"used": false
},
"pii_zrm_workspace": false,
"pii_zrm_agent": false,
"tool_dynamic_variable_updates": {
"enabled": false,
"used": false
},
"is_livekit": false,
"voicemail_detection": {
"enabled": false,
"used": false
},
"workflow": {
"enabled": false,
"tool_node": {
"enabled": false,
"used": false
},
"standalone_agent_node": {
"enabled": false,
"used": false
},
"phone_number_node": {
"enabled": false,
"used": false
},
"end_node": {
"enabled": false,
"used": false
}
},
"agent_testing": {
"enabled": false,
"tests_ran_after_last_modification": false,
"tests_ran_in_last_7_days": false
},
"versioning": {
"enabled": false,
"used": false
}
},
"ree_assistant": {
"is_ree_assistant": false
},
"initiator_id": "<string>",
"conversation_initiation_source": "unknown",
"conversation_initiation_source_version": "<string>",
"timezone": "<string>",
"initiation_trigger": {
"trigger_type": "default"
},
"async_metadata": {
"delivery_status": "pending",
"delivery_timestamp": 123,
"external_system": "<string>",
"external_id": "<string>",
"delivery_error": "<string>",
"retry_count": 0,
"last_retry_timestamp": 123
},
"whatsapp": {
"whatsapp_user_id": "<string>",
"direction": "unknown",
"whatsapp_phone_number_id": "<string>"
},
"agent_created_from": "unknown",
"agent_last_updated_from": "unknown"
},
"has_audio": true,
"has_user_audio": true,
"has_response_audio": true,
"user_id": "<string>",
"branch_id": "<string>",
"analysis": {
"call_successful": "success",
"transcript_summary": "<string>",
"call_summary_title": "<string>",
"evaluation_criteria_results": {},
"data_collection_results": {}
},
"conversation_initiation_client_data": {
"conversation_config_override": {
"turn": {},
"tts": {},
"conversation": {},
"agent": {}
},
"custom_llm_extra_body": {},
"user_id": "<string>",
"source_info": {
"source": "unknown",
"version": "<string>"
},
"dynamic_variables": {}
}
}Get the details of a particular conversation
curl --request GET \
--url https://api.example.com/v1/voiceai/conversations/{conversation_id} \
--header 'x-api-key: <api-key>'{
"agent_id": "<string>",
"conversation_id": "<string>",
"status": "initiated",
"transcript": [
{
"role": "user",
"time_in_call_secs": 123,
"message": "<string>",
"interrupted": false,
"original_message": "<string>",
"source_medium": "audio",
"llm_override": "<string>",
"tool_calls": [
{
"request_id": "<string>",
"tool_name": "<string>",
"params_as_json": "<string>",
"tool_has_been_called": true,
"type": "system",
"tool_details": {
"type": "webhook",
"url": "<string>",
"method": "<string>"
}
}
],
"tool_results": [
{
"request_id": "<string>",
"tool_name": "<string>",
"result_value": "<string>",
"is_error": true,
"tool_has_been_called": true,
"tool_latency_secs": 0,
"dynamic_variable_updates": [
{
"variable_name": "<string>",
"old_value": "<string>",
"new_value": "<string>",
"updated_at": 123,
"tool_name": "<string>",
"tool_request_id": "<string>"
}
],
"type": "client"
}
],
"feedback": {
"score": "like",
"time_in_call_secs": 123
},
"conversation_turn_metrics": {
"metrics": {}
},
"rag_retrieval_info": {
"embedding_model": "gemini-embedding-001",
"retrieval_query": "<string>",
"rag_latency_secs": 123,
"chunks": [
{
"document_id": "<string>",
"chunk_id": "<string>",
"vector_distance": 123
}
]
},
"llm_usage": {
"model_usage": {}
},
"agent_metadata": {
"agent_id": "<string>",
"branch_id": "<string>",
"workflow_node_id": "<string>"
}
}
],
"metadata": {
"start_time_unix_secs": 123,
"call_duration_secs": 123,
"accepted_time_unix_secs": 123,
"cost": 123,
"charging": {
"dev_discount": false,
"is_burst": false,
"tier": "<string>",
"llm_usage": {
"irreversible_generation": {
"model_usage": {}
},
"initiated_generation": {
"model_usage": {}
}
},
"llm_price": 123,
"llm_charge": 123,
"call_charge": 123,
"free_minutes_consumed": 0,
"free_llm_dollars_consumed": 0
},
"deletion_settings": {
"deletion_time_unix_secs": 123,
"deleted_logs_at_time_unix_secs": 123,
"deleted_audio_at_time_unix_secs": 123,
"deleted_transcript_at_time_unix_secs": 123,
"delete_transcript_and_pii": false,
"delete_audio": false
},
"feedback": {
"type": "thumbs",
"overall_score": "like",
"likes": 0,
"dislikes": 0,
"rating": 123,
"comment": "<string>"
},
"authorization_method": "public",
"phone_call": {
"direction": "inbound",
"phone_number_id": "<string>",
"agent_number": "<string>",
"external_number": "<string>",
"call_sid": "<string>"
},
"batch_call": {
"batch_call_id": "<string>",
"batch_call_recipient_id": "<string>"
},
"termination_reason": "",
"error": {
"code": 123,
"reason": "<string>"
},
"warnings": [
"<string>"
],
"main_language": "<string>",
"rag_usage": {
"usage_count": 123,
"embedding_model": "<string>"
},
"text_only": false,
"features_usage": {
"language_detection": {
"enabled": false,
"used": false
},
"transfer_to_agent": {
"enabled": false,
"used": false
},
"transfer_to_number": {
"enabled": false,
"used": false
},
"multivoice": {
"enabled": false,
"used": false
},
"dtmf_tones": {
"enabled": false,
"used": false
},
"external_mcp_servers": {
"enabled": false,
"used": false
},
"pii_zrm_workspace": false,
"pii_zrm_agent": false,
"tool_dynamic_variable_updates": {
"enabled": false,
"used": false
},
"is_livekit": false,
"voicemail_detection": {
"enabled": false,
"used": false
},
"workflow": {
"enabled": false,
"tool_node": {
"enabled": false,
"used": false
},
"standalone_agent_node": {
"enabled": false,
"used": false
},
"phone_number_node": {
"enabled": false,
"used": false
},
"end_node": {
"enabled": false,
"used": false
}
},
"agent_testing": {
"enabled": false,
"tests_ran_after_last_modification": false,
"tests_ran_in_last_7_days": false
},
"versioning": {
"enabled": false,
"used": false
}
},
"ree_assistant": {
"is_ree_assistant": false
},
"initiator_id": "<string>",
"conversation_initiation_source": "unknown",
"conversation_initiation_source_version": "<string>",
"timezone": "<string>",
"initiation_trigger": {
"trigger_type": "default"
},
"async_metadata": {
"delivery_status": "pending",
"delivery_timestamp": 123,
"external_system": "<string>",
"external_id": "<string>",
"delivery_error": "<string>",
"retry_count": 0,
"last_retry_timestamp": 123
},
"whatsapp": {
"whatsapp_user_id": "<string>",
"direction": "unknown",
"whatsapp_phone_number_id": "<string>"
},
"agent_created_from": "unknown",
"agent_last_updated_from": "unknown"
},
"has_audio": true,
"has_user_audio": true,
"has_response_audio": true,
"user_id": "<string>",
"branch_id": "<string>",
"analysis": {
"call_successful": "success",
"transcript_summary": "<string>",
"call_summary_title": "<string>",
"evaluation_criteria_results": {},
"data_collection_results": {}
},
"conversation_initiation_client_data": {
"conversation_config_override": {
"turn": {},
"tts": {},
"conversation": {},
"agent": {}
},
"custom_llm_extra_body": {},
"user_id": "<string>",
"source_info": {
"source": "unknown",
"version": "<string>"
},
"dynamic_variables": {}
}
}API key for programmatic access
The id of the conversation you're taking the action on.
Successful Response
Response model for Get Conversation Details endpoint.
The ID of the agent
The unique identifier for the conversation
Current status of the conversation
initiated, in-progress, processing, done, failed List of transcript entries
Show child attributes
Conversation metadata
Show child attributes
Whether audio recording is available
Whether user audio is available
Whether agent response audio is available
ID of the end user (for agent owner's identification)
The ID of the agent branch (if applicable)
Conversation analysis results
Show child attributes
Client data from conversation initiation
Show child attributes