Resolve conversation reference

GET

/v1/convai/conversations/resolve

GET

/v1/convai/conversations/resolve

$ curl -G https://api.elevenlabs.io/v1/convai/conversations/resolve \
>      -d agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz \
>      --data-urlencode reference=https://your-domain.zendesk.com/agent/tickets/12345

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

Resolve a conversation URL (a Slack message URL or a Zendesk ticket URL) to the deterministic conversation ID for the given agent, then confirm the conversation exists.

Query parameters

agent_idstringRequired

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

referencestringRequired

A Slack message URL or a Zendesk ticket URL.

Response

Successful Response

agent_idstring

statusenum

metadataobject

conversation_idstring

has_audioboolean

has_user_audioboolean

has_response_audioboolean

has_auxiliary_audioboolean

transcriptlist of objects

agent_namestringOptional

conversation_productstringOptionalDefaults to agent

user_idstringOptional

branch_idstringOptional

version_idstringOptional

The ID of the agent version used for this conversation

analysisobjectOptional

visited_agentslist of objectsOptional

conversation_initiation_client_dataobjectOptional

environmentstringOptionalDefaults to production

tag_idslist of stringsOptional

Conversation tag ids assigned to this conversation.

otlp_tracesmap from strings to anyOptional

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

Errors

422

Conversations Resolve Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors