Skip to navigation
API referenceConversations

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_idstringRequired
The id of the conversation you're taking the action on.

Headers

xi-api-keystringOptional

Query parameters

max_messagesintegerOptional1-200Defaults to 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.

Response

Successful Response
conversation_idstring
agent_idstring
statusenum
Allowed values:
message_countinteger
Number of plain chat message turns in the conversation.
notestring
Guidance telling the agent how to get the full transcript.
call_summary_titlestringOptional
Short generated title for the conversation.
transcript_summarystringOptional

Generated natural-language summary of the call.

call_successfulenumOptional
Allowed values:
messageslist of objectsOptional

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_omittedbooleanOptionalDefaults to false
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