Run conversation analysis

POST

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

POST

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

$ curl -X POST https://api.elevenlabs.io/v1/convai/conversations/conversation_id/analysis/run

1 {
2   "agent_id": "agent_id",
3   "status": "initiated",
4   "metadata": {
5     "start_time_unix_secs": 1,
6     "call_duration_secs": 1,
7     "accepted_time_unix_secs": 1,
8     "cost": 1,
9     "deletion_settings": {
10       "deletion_time_unix_secs": 1,
11       "deleted_logs_at_time_unix_secs": 1,
12       "deleted_audio_at_time_unix_secs": 1,
13       "deleted_transcript_at_time_unix_secs": 1,
14       "delete_transcript_and_pii": true,
15       "delete_audio": true
16     },
17     "feedback": {
18       "type": "thumbs",
19       "overall_score": "like",
20       "likes": 1,
21       "dislikes": 1,
22       "rating": 1,
23       "comment": "comment"
24     },
25     "authorization_method": "invalid",
26     "charging": {
27       "dev_discount": true,
28       "is_burst": true,
29       "tier": "tier",
30       "llm_price": 1.1,
31       "llm_charge": 1,
32       "call_charge": 1,
33       "free_minutes_consumed": 1.1,
34       "free_llm_dollars_consumed": 1.1
35     },
36     "phone_call": {
37       "type": "exotel",
38       "agent_number": "agent_number",
39       "call_sid": "call_sid",
40       "direction": "inbound",
41       "external_number": "external_number",
42       "phone_number_id": "phone_number_id",
43       "stream_sid": "stream_sid"
44     },
45     "batch_call": {
46       "batch_call_id": "batch_call_id",
47       "batch_call_recipient_id": "batch_call_recipient_id"
48     },
49     "termination_reason": "termination_reason",
50     "error": {
51       "code": 1,
52       "reason": "reason"
53     },
54     "warnings": [
55       "warnings"
56     ],
57     "main_language": "main_language",
58     "rag_usage": {
59       "usage_count": 1,
60       "embedding_model": "embedding_model"
61     },
62     "text_only": true,
63     "features_usage": {
64       "pii_zrm_workspace": true,
65       "pii_zrm_agent": true,
66       "is_livekit": true
67     },
68     "eleven_assistant": {
69       "is_eleven_assistant": true
70     },
71     "initiator_id": "initiator_id",
72     "conversation_initiation_source": "unknown",
73     "conversation_initiation_source_version": "conversation_initiation_source_version",
74     "timezone": "timezone",
75     "async_metadata": {
76       "delivery_status": "pending",
77       "delivery_timestamp": 1,
78       "external_system": "external_system",
79       "external_id": "external_id",
80       "delivery_error": "delivery_error",
81       "external_link": "external_link",
82       "retry_count": 1,
83       "last_retry_timestamp": 1,
84       "last_processed_external_message_id": "last_processed_external_message_id"
85     },
86     "whatsapp": {
87       "whatsapp_user_id": "whatsapp_user_id",
88       "direction": "inbound",
89       "whatsapp_phone_number_id": "whatsapp_phone_number_id",
90       "awaiting_first_user_message": true
91     },
92     "sms": {
93       "direction": "inbound",
94       "sms_user_phone_number": "sms_user_phone_number",
95       "phone_number_id": "phone_number_id",
96       "agent_phone_number": "agent_phone_number"
97     },
98     "agent_created_from": "cli",
99     "agent_last_updated_from": "cli",
100     "voice_rewards": [
101       {
102         "voice_id": "voice_id",
103         "reward_usd_cents": 1.1
104       }
105     ]
106   },
107   "conversation_id": "conversation_id",
108   "has_audio": true,
109   "has_user_audio": true,
110   "has_response_audio": true,
111   "transcript": [
112     {
113       "role": "user",
114       "time_in_call_secs": 1,
115       "agent_metadata": {
116         "agent_id": "agent_id"
117       },
118       "message": "message",
119       "multivoice_message": {
120         "parts": [
121           {
122             "text": "text",
123             "voice_label": null,
124             "time_in_call_secs": null
125           }
126         ]
127       },
128       "tool_calls": [
129         {
130           "request_id": "request_id",
131           "tool_name": "tool_name",
132           "params_as_json": "params_as_json",
133           "tool_has_been_called": true
134         }
135       ],
136       "tool_results": [
137         {
138           "request_id": "request_id",
139           "tool_name": "tool_name",
140           "result_value": "result_value",
141           "is_error": true,
142           "tool_has_been_called": true
143         }
144       ],
145       "feedback": {
146         "score": "like",
147         "time_in_call_secs": 1
148       },
149       "llm_override": "llm_override",
150       "rag_retrieval_info": {
151         "chunks": [
152           {
153             "document_id": "document_id",
154             "chunk_id": "chunk_id",
155             "vector_distance": 1.1
156           }
157         ],
158         "embedding_model": "e5_mistral_7b_instruct",
159         "retrieval_query": "retrieval_query",
160         "rag_latency_secs": 1.1
161       },
162       "interrupted": true,
163       "original_message": "original_message",
164       "source_medium": "audio",
165       "source_event_id": 1,
166       "used_static_kb_document_ids": [
167         "used_static_kb_document_ids"
168       ],
169       "file_input": {
170         "file_id": "file_id",
171         "original_filename": "original_filename",
172         "mime_type": "mime_type",
173         "file_url": "file_url"
174       },
175       "contextual_update_info": {
176         "context_id": "context_id"
177       }
178     }
179   ],
180   "agent_name": "agent_name",
181   "conversation_product": "conversation_product",
182   "user_id": "user_id",
183   "branch_id": "branch_id",
184   "version_id": "version_id",
185   "analysis": {
186     "call_successful": "success",
187     "transcript_summary": "transcript_summary",
188     "evaluation_criteria_results": {
189       "key": {
190         "criteria_id": "criteria_id",
191         "result": "success",
192         "rationale": "rationale"
193       }
194     },
195     "data_collection_results": {
196       "key": {
197         "data_collection_id": "data_collection_id",
198         "rationale": "rationale",
199         "json_schema": {
200           "type": "string",
201           "description": "A user-provided message"
202         }
203       }
204     },
205     "evaluation_criteria_results_list": [
206       {
207         "criteria_id": "criteria_id",
208         "result": "success",
209         "rationale": "rationale"
210       }
211     ],
212     "data_collection_results_list": [
213       {
214         "data_collection_id": "data_collection_id",
215         "rationale": "rationale",
216         "json_schema": {
217           "type": "string",
218           "description": "A user-provided message"
219         }
220       }
221     ],
222     "call_summary_title": "call_summary_title",
223     "scoped": [
224       {
225         "scope": "conversation",
226         "source_agent_id": "source_agent_id",
227         "successful": "success"
228       }
229     ]
230   },
231   "visited_agents": [
232     {
233       "agent_id": "agent_id",
234       "branch_id": "branch_id"
235     }
236   ],
237   "conversation_initiation_client_data": {
238     "conversation_config_override": {
239       "asr": {
240         "keywords": [
241           "hello",
242           "world"
243         ]
244       },
245       "turn": {
246         "soft_timeout_config": {
247           "message": "Hhmmmm...yeah."
248         }
249       },
250       "tts": {
251         "voice_id": "cjVigY5qzO86Huf0OWal",
252         "stability": 0.5,
253         "speed": 1,
254         "similarity_boost": 0.8
255       },
256       "agent": {
257         "first_message": "Hello, how can I help you today?",
258         "language": "en",
259         "prompt": {
260           "prompt": "You are a helpful assistant that can answer questions about the topic of the conversation.",
261           "llm": "gemini-2.0-flash-001",
262           "tool_ids": [
263             "tool_ids"
264           ],
265           "knowledge_base": [
266             {
267               "type": "file",
268               "name": "My Knowledge Base",
269               "id": "123",
270               "usage_mode": "auto"
271             }
272           ]
273         }
274       }
275     },
276     "custom_llm_extra_body": {
277       "key": "value"
278     },
279     "user_id": "user_id",
280     "source_info": {
281       "source": "unknown",
282       "version": "version"
283     },
284     "branch_id": "branch_id",
285     "environment": "environment",
286     "starting_workflow_node_id": "starting_workflow_node_id",
287     "dynamic_variables": {
288       "key": "value"
289     }
290   },
291   "environment": "environment",
292   "tag_ids": [
293     "tag_ids"
294   ],
295   "otlp_traces": {
296     "key": "value"
297   }
298 }

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

metadataobject

conversation_idstring

has_audioboolean

has_user_audioboolean

has_response_audioboolean

transcriptlist of objects

agent_namestring

conversation_productstringDefaults to agent

user_idstring

branch_idstring

version_idstring

The ID of the agent version used for this conversation

analysisobject

visited_agentslist of objects

conversation_initiation_client_dataobject

environmentstringDefaults to production

tag_idslist of strings

Conversation tag ids assigned to this conversation.

otlp_tracesmap from strings to any

OpenTelemetry trace payload when the request uses format=opentelemetry; otherwise omitted.

Errors

422

Analysis Run Request Unprocessable Entity Error

Path parameters

Headers

Response

Errors