Agents Platform

Get Conversation Summary

Changed on

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.

get/v1/convai/conversations/{conversation_id}/summary

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/conversations/{conversation_id}/summary
  • Auth
    none declared

Path parameters

conversation_idstring required

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

Example:21m00Tcm4TlvDq8ikWAM

Query parameters

max_messagesinteger

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.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

conversation_idstring required
agent_idstring required
status'initiated' | 'in-progress' | 'processing' | 'done' | 'failed' required
call_summary_titlestring nullable

Short generated title for the conversation.

transcript_summarystring nullable

Generated natural-language summary of the call.

call_successful'success' | 'failure' | 'unknown'
message_countinteger required

Number of plain chat message turns in the conversation.

messages_omittedboolean

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

notestring required

Guidance telling the agent how to get the full transcript.

Changes