Skip to main content
GET
Get Conversation Summary

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

conversation_id
string
required

The id of the conversation you're taking the action on.

Example:

"21m00Tcm4TlvDq8ikWAM"

Query Parameters

max_messages
integer
default:40

Maximum number of chat message turns to include inline. When the conversation has more than this, the messages are omitted and messages_omitted is set.

Required range: 1 <= x <= 200

Response

Successful Response

conversation_id
string
required
agent_id
string
required
status
enum<string>
required
Available options:
initiated,
in-progress,
processing,
done,
failed
message_count
integer
required

Number of plain chat message turns in the conversation.

note
string
required

Guidance telling the agent how to get the full transcript.

call_summary_title
string | null

Short generated title for the conversation.

transcript_summary
string | null

Generated natural-language summary of the call.

call_successful
enum<string> | null
Available options:
success,
failure,
unknown
messages
ConversationSummaryMessageModel · object[] | null

The plain chat messages (role and text only). Included only when message_count does not exceed the requested max_messages; otherwise null and messages_omitted is true.

messages_omitted
boolean
default:false

True when the chat messages were omitted because the conversation was too long. Fetch the full transcript for the messages.