Get conversation summary
Get a lightweight summary of a conversation: its title, the generated transcript summary, whether the call was successful, and — only when the conversation is short — the plain chat messages. Tool calls, tool results, and contextual updates are omitted so the response stays small. Use this instead of the full conversation endpoint when you only need the gist (e.g. an agent reading many conversations); use GET /v1/convai/conversations/{conversation_id} when you need the full transcript with tool calls and contextual updates.
Path parameters
conversation_id
The id of the conversation you're taking the action on.
Headers
xi-api-key
Query parameters
max_messages
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.
Response
Successful Response
conversation_id
agent_id
status
message_count
Number of plain chat message turns in the conversation.
note
Guidance telling the agent how to get the full transcript.
call_summary_title
Short generated title for the conversation.
transcript_summary
Generated natural-language summary of the call.
call_successful
messages
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
True when the chat messages were omitted because the conversation was too long. Fetch the full transcript for the messages.
Errors
422
Conversations Get Summary Request Unprocessable Entity Error