Quickstart
- Agent Setup
- Build a Conversational App
- Twilio Integration
Libraries & SDKs
API Reference
- WebSocket
- Agents
- Conversations
- Knowledge Base
- Phone Numbers
- Widget
Conversations
Get Conversation Details
Get the details of a particular conversation
GET
/
v1
/
convai
/
conversations
/
{conversation_id}
Copy
Ask AI
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_conversation(
conversation_id="21m00Tcm4TlvDq8ikWAM",
)
Copy
Ask AI
{
"agent_id": "<string>",
"conversation_id": "<string>",
"status": "processing",
"transcript": [
{
"role": "user",
"message": "<string>",
"tool_calls": [
{
"request_id": "<string>",
"tool_name": "<string>",
"params_as_json": "<string>",
"tool_has_been_called": true
}
],
"tool_results": [
{
"request_id": "<string>",
"tool_name": "<string>",
"result_value": "<string>",
"is_error": true,
"tool_has_been_called": true
}
],
"feedback": {
"score": "like",
"time_in_call_secs": 123
},
"time_in_call_secs": 123,
"conversation_turn_metrics": {}
}
],
"metadata": {
"start_time_unix_secs": 123,
"call_duration_secs": 123,
"cost": 123,
"feedback": {
"overall_score": "like",
"likes": 0,
"dislikes": 0
},
"authorization_method": "public",
"charging": {
"dev_discount": false
}
},
"analysis": {
"evaluation_criteria_results": {},
"data_collection_results": {},
"call_successful": "success",
"transcript_summary": "<string>"
},
"conversation_initiation_client_data": {
"conversation_config_override": {
"agent": {
"prompt": {
"prompt": ""
},
"first_message": "<string>",
"language": "<string>"
},
"tts": {
"voice_id": "<string>"
}
},
"custom_llm_extra_body": {}
}
}
Headers
Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.
Path Parameters
The id of the conversation you're taking the action on.
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
Ask AI
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.conversational_ai.get_conversation(
conversation_id="21m00Tcm4TlvDq8ikWAM",
)
Copy
Ask AI
{
"agent_id": "<string>",
"conversation_id": "<string>",
"status": "processing",
"transcript": [
{
"role": "user",
"message": "<string>",
"tool_calls": [
{
"request_id": "<string>",
"tool_name": "<string>",
"params_as_json": "<string>",
"tool_has_been_called": true
}
],
"tool_results": [
{
"request_id": "<string>",
"tool_name": "<string>",
"result_value": "<string>",
"is_error": true,
"tool_has_been_called": true
}
],
"feedback": {
"score": "like",
"time_in_call_secs": 123
},
"time_in_call_secs": 123,
"conversation_turn_metrics": {}
}
],
"metadata": {
"start_time_unix_secs": 123,
"call_duration_secs": 123,
"cost": 123,
"feedback": {
"overall_score": "like",
"likes": 0,
"dislikes": 0
},
"authorization_method": "public",
"charging": {
"dev_discount": false
}
},
"analysis": {
"evaluation_criteria_results": {},
"data_collection_results": {},
"call_successful": "success",
"transcript_summary": "<string>"
},
"conversation_initiation_client_data": {
"conversation_config_override": {
"agent": {
"prompt": {
"prompt": ""
},
"first_message": "<string>",
"language": "<string>"
},
"tts": {
"voice_id": "<string>"
}
},
"custom_llm_extra_body": {}
}
}
Assistant
Responses are generated using AI and may contain mistakes.