快速开始Conversations

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.

路径参数

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

请求头

xi-api-keystring可选

查询参数

max_messagesinteger可选1-200默认为 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.

响应

Successful Response
conversation_idstring
agent_idstring
statusenum
允许的值:
message_countinteger
Number of plain chat message turns in the conversation.
notestring
Guidance telling the agent how to get the full transcript.
call_summary_titlestring可选
Short generated title for the conversation.
transcript_summarystring可选

Generated natural-language summary of the call.

call_successfulenum可选
允许的值:
messageslist of objects可选

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_omittedboolean可选默认为 false
True when the chat messages were omitted because the conversation was too long. Fetch the full transcript for the messages.

错误

422
Conversations Get Summary Request Unprocessable Entity Error