Run conversation analysis

POST

/v1/convai/conversations/:conversation_id/analysis/run

POST

/v1/convai/conversations/:conversation_id/analysis/run

1 from elevenlabs import ElevenLabs
2 
3 client = ElevenLabs()
4 
5 client.conversational_ai.conversations.analysis.run(
6     conversation_id="conversation_id",
7 )

1 {
2   "agent_id": "agent_12345",
3   "status": "initiated",
4   "metadata": {
5     "start_time_unix_secs": 1688000000,
6     "call_duration_secs": 360,
7     "accepted_time_unix_secs": 1688000020,
8     "cost": 15,
9     "deletion_settings": {
10       "deletion_time_unix_secs": 1690600000,
11       "deleted_logs_at_time_unix_secs": 1690603600,
12       "deleted_audio_at_time_unix_secs": 1690607200,
13       "deleted_transcript_at_time_unix_secs": 1690610800,
14       "delete_transcript_and_pii": true,
15       "delete_audio": true
16     },
17     "feedback": {
18       "type": "thumbs",
19       "overall_score": "like",
20       "likes": 12,
21       "dislikes": 2,
22       "rating": 5,
23       "comment": "Agent was very helpful and resolved my issue quickly."
24     },
25     "authorization_method": "authorization_header",
26     "charging": {
27       "dev_discount": false,
28       "is_burst": false,
29       "tier": "premium",
30       "llm_price": 3.75,
31       "llm_charge": 3,
32       "call_charge": 12,
33       "free_minutes_consumed": 0,
34       "free_llm_dollars_consumed": 0
35     },
36     "phone_call": {
37       "type": "sip_trunking",
38       "agent_number": "+15551234567",
39       "call_sid": "CA1234567890abcdef",
40       "direction": "inbound",
41       "external_number": "+15557654321",
42       "phone_number_id": "phone_num_98765",
43       "sip_header_dynamic_variables": {
44         "X-Custom-Header": "CustomValue"
45       }
46     },
47     "batch_call": {
48       "batch_call_id": "batch_202406",
49       "batch_call_recipient_id": "recipient_42"
50     },
51     "termination_reason": "call_completed",
52     "error": {
53       "code": 0
54     },
55     "warnings": [
56       "Low audio quality detected"
57     ],
58     "main_language": "en",
59     "rag_usage": {
60       "usage_count": 5,
61       "embedding_model": "e5_mistral_7b_instruct"
62     },
63     "text_only": false,
64     "features_usage": {
65       "pii_zrm_workspace": false,
66       "pii_zrm_agent": false,
67       "is_livekit": false
68     },
69     "eleven_assistant": {
70       "is_eleven_assistant": true
71     },
72     "initiator_id": "initiator_abc123",
73     "conversation_initiation_source": "widget",
74     "conversation_initiation_source_version": "1.4.2",
75     "timezone": "America/New_York",
76     "async_metadata": {
77       "delivery_status": "success",
78       "delivery_timestamp": 1688000360,
79       "external_system": "zendesk",
80       "external_id": "zendesk_ticket_1234",
81       "retry_count": 0,
82       "last_processed_external_message_id": "msg_7890"
83     },
84     "whatsapp": {
85       "whatsapp_user_id": "wa_user_456",
86       "direction": "inbound",
87       "whatsapp_phone_number_id": "wa_num_123",
88       "awaiting_first_user_message": false
89     },
90     "agent_created_from": "ui",
91     "agent_last_updated_from": "api"
92   },
93   "conversation_id": "conv_abc123xyz",
94   "has_audio": true,
95   "has_user_audio": true,
96   "has_response_audio": true,
97   "transcript": [
98     {
99       "role": "user",
100       "time_in_call_secs": 10,
101       "agent_metadata": {
102         "agent_id": "agent_12345"
103       },
104       "message": "I need help with my billing statement.",
105       "multivoice_message": {
106         "parts": [
107           {
108             "text": "I need help with my billing statement.",
109             "time_in_call_secs": 5
110           }
111         ]
112       },
113       "tool_calls": [
114         {
115           "request_id": "req_001",
116           "tool_name": "billing_lookup",
117           "params_as_json": "{\"account_id\":\"user_67890\"}",
118           "tool_has_been_called": true
119         }
120       ],
121       "tool_results": [
122         {
123           "request_id": "req_001",
124           "tool_name": "billing_lookup",
125           "result_value": "{\"balance_due\":50.00,\"due_date\":\"2024-07-15\"}",
126           "is_error": false,
127           "tool_has_been_called": true
128         }
129       ],
130       "feedback": {
131         "score": "like",
132         "time_in_call_secs": 10
133       },
134       "rag_retrieval_info": {
135         "chunks": [
136           {
137             "document_id": "doc_123",
138             "chunk_id": "chunk_456",
139             "vector_distance": 0.12
140           }
141         ],
142         "embedding_model": "e5_mistral_7b_instruct",
143         "retrieval_query": "billing statement details",
144         "rag_latency_secs": 0.35
145       },
146       "interrupted": false,
147       "original_message": "I need help with my billing statement.",
148       "source_medium": "audio",
149       "source_event_id": 101,
150       "file_input": {
151         "file_id": "file_789",
152         "original_filename": "billing_query.wav",
153         "mime_type": "audio/wav",
154         "file_url": "https://storage.example.com/files/billing_query.wav"
155       }
156     }
157   ],
158   "agent_name": "SupportBot Alpha",
159   "user_id": "user_67890",
160   "branch_id": "branch_001",
161   "version_id": "v2.3.4",
162   "analysis": {
163     "call_successful": "success",
164     "transcript_summary": "The conversation was smooth and the agent resolved the customer's issue efficiently.",
165     "evaluation_criteria_results": {
166       "response_accuracy": {
167         "criteria_id": "response_accuracy",
168         "result": "success",
169         "rationale": "Agent provided accurate and relevant information."
170       }
171     },
172     "data_collection_results": {
173       "customer_satisfaction": {
174         "data_collection_id": "customer_satisfaction",
175         "rationale": "Customer rated the interaction as 5 stars.",
176         "json_schema": {
177           "type": "string",
178           "description": "Customer satisfaction rating from 1 to 5"
179         }
180       }
181     },
182     "evaluation_criteria_results_list": [
183       {
184         "criteria_id": "response_accuracy",
185         "result": "success",
186         "rationale": "Agent provided accurate and relevant information."
187       }
188     ],
189     "data_collection_results_list": [
190       {
191         "data_collection_id": "customer_satisfaction",
192         "rationale": "Customer rated the interaction as 5 stars.",
193         "json_schema": {
194           "type": "string",
195           "description": "Customer satisfaction rating from 1 to 5"
196         }
197       }
198     ],
199     "call_summary_title": "Successful Support Call"
200   },
201   "conversation_initiation_client_data": {
202     "conversation_config_override": {
203       "turn": {
204         "soft_timeout_config": {
205           "message": "Please hold on, I'm fetching that information for you."
206         }
207       },
208       "tts": {
209         "voice_id": "cjVigY5qzO86Huf0OWal",
210         "stability": 0.7,
211         "speed": 1.1,
212         "similarity_boost": 0.85
213       },
214       "agent": {
215         "first_message": "Hello, how can I assist you today?",
216         "language": "en",
217         "prompt": {
218           "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
219           "llm": "gemini-2.0-flash-001"
220         }
221       }
222     },
223     "custom_llm_extra_body": {
224       "priority": "high",
225       "session_id": "sess_7890"
226     },
227     "user_id": "user_67890",
228     "source_info": {
229       "source": "widget",
230       "version": "1.4.2"
231     },
232     "branch_id": "branch_001",
233     "environment": "production",
234     "dynamic_variables": {
235       "customer_tier": "gold",
236       "issue_type": "billing"
237     }
238   },
239   "environment": "production"
240 }

Run the analysis for a conversation using the agent's current evaluation criteria and data collection settings.

Path parameters

conversation_idstringRequired

ID of the conversation

Response

Successful Response

agent_idstring

statusenum

Allowed values:

metadataobject

conversation_idstring

has_audioboolean

has_user_audioboolean

has_response_audioboolean

transcriptlist of objects

agent_namestring

user_idstring

branch_idstring

version_idstring

The ID of the agent version used for this conversation

analysisobject

conversation_initiation_client_dataobject

environmentstringDefaults to production

Errors

422

Analysis Run Request Unprocessable Entity Error

Path parameters

Headers

Response

Errors