GET /get-chat/{chat_id}
Changed onRetrieve details of a specific chat
Request
- Base URLhttps://api.retellai.com
- AuthHTTP bearer
Path parameters
Unique id of the chat to be retrieved
Response
Successfully retrieved a chat.
Example response
{
"chat_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
"version": 1,
"agent_tag": "prod",
"retell_llm_dynamic_variables": {
"customer_name": "John Doe"
},
"collected_dynamic_variables": {
"last_node_name": "Test node"
},
"chat_status": "ongoing",
"chat_type": "api_chat",
"start_timestamp": 1703302407333,
"end_timestamp": 1703302428855,
"transcript": "Agent: hi how are you doing?\nUser: Doing pretty well. How are you?\nAgent: That's great to hear! I'm doing well too, thanks! What's up?\nUser: I don't have anything in particular.\nAgent: Got it, just checking in!\nUser: Alright. See you.\nAgent: have a nice day\n",
"message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"pre_session_message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"scrubbed_pre_session_message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"post_session_message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"scrubbed_post_session_message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"chat_cost": {
"product_costs": [
{
"product": "elevenlabs_tts",
"unit_price": 1,
"cost": 60
}
],
"combined_cost": 70
},
"chat_analysis": {
"chat_summary": "The agent messages user to ask question about his purchase inquiry. The agent asked several questions regarding his preference and asked if user would like to book an appointment. The user happily agreed and scheduled an appointment next Monday 10am.",
"user_sentiment": "Positive",
"chat_successful": true
}
}Changes
- breaking
added to the
/response propertyoneOflist for the response status - info
added the optional property
to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
//////////to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- breaking
- breaking
the
/response's property type changed from no type tostringfor status - breaking
the
/response's property type changed from no type tostringfor status
- breaking