Retrieving AI Conversation Summary

  • Published on Feb 12, 2026
  • 3 minute(s) read
  • EM
 Prev Next
Get
/ai-services/summary_conversation

This API retrieves the AI-generated summary of a customer-agent conversation that were previously requested via the POST AI Conversation Summary Request API. The AI analyzes the conversation and generates a structured summary in the language specified in the original request.

How It Works

  1. Request a summary - Use the POST endpoint to initiate AI analysis of a conversation
  2. Receive action_id - The POST request returns a unique action_id for tracking
  3. Poll for results - Use this GET endpoint with the action_id to check if the summary is ready
  4. Processing states:
    • Pending - AI is still analyzing the conversation
    • Completed - Summary is ready and returned in the answer field
    • Failed - An error occurred during processing

Key Features

  • Asynchronous processing - Summaries are generated in the background
  • Automated translation - Results provided in the language specified in the original request
  • Structured output - Summaries include key conversation points and action items
  • Unique tracking - Each request has a persistent action_id for reliable retrieval

Best Practices

  • Poll every 2-5 seconds to check if the summary is ready
  • Cache completed summaries using the action_id as the key
Security
HTTP
Type bearer

API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.

Query parameters
action_id
stringRequired

Unique identifier from the POST AI conversation API payload

ExampleAI_API_SUMMARY_e54ae358-f7b9-45c0-9e6c-da581e0964dc
Responses
200

Summary request status retrieved successfully. The status field indicates whether the summary is ready.

completed

Summary generation completed successfully

{
  "status": "Completed",
  "answer": "- **Client reason for contact**:\n  - The client noticed an unfamiliar transaction of $12.50 from a merchant they do not recognize.\n\n- **Agent actions taken**:\n  - Verified the transaction details and identified it as a recurring subscription.\n\n- **Resolution**:\n  - Client recognized the subscription after verification.",
  "action_id": "AI_API_SUMMARY_2f6995be-d52b-484b-9bae-2578227caf58"
}
pending

Summary is still being generated

{
  "status": "Pending",
  "action_id": "AI_API_SUMMARY_2f6995be-d52b-484b-9bae-2578227caf58"
}
failed

Summary generation failed

{
  "status": "Failed",
  "action_id": "AI_API_SUMMARY_2f6995be-d52b-484b-9bae-2578227caf58",
  "error_message": "Conversation data not found or insufficient content for summarization"
}
object
status
string

Current processing status of the AI conversation summary

Valid values[ "Pending", "Completed", "Failed" ]
ExampleCompleted
answer
string | null

The AI-generated conversation summary. Only populated when status is 'Completed'. Contains structured markdown with conversation highlights, key points, and action items.

Example- **Client reason for contact**: - The client noticed an unfamiliar transaction of $12.50 from a merchant they do not recognize. - The client is considering applying for a home loan and wants to understand how this might affect their credit score. - **Agent actions taken**: - Verified the transaction details and identified it as a recurring subscription charge. - Explained the credit inquiry process for home loan applications. - Provided information about credit monitoring services. - **Resolution**: - Client recognized the subscription and decided to keep it active. - Agent sent follow-up email with home loan application checklist. - **Next steps**: - Client to review credit report before applying for home loan. - Follow-up call scheduled for next week to discuss application process.
action_id
string

Unique identifier for tracking this summary request. Same as the input parameter.

ExampleAI_API_SUMMARY_2f6995be-d52b-484b-9bae-2578227caf58
error_message
string | null

Error details if status is 'Failed'. Not present for Pending or Completed status.

ExampleConversation data not found or insufficient content for summarization
400

Bad request - invalid input parameters

object
error
string
ExampleInvalid parameter
status
integer
Example400
response_time
string (date-time)
Example2025-12-14T07:26:35.975Z
401

Unauthorized

object
error
boolean
Exampletrue
message
string
ExampleInvalid or missing authentication token
status
integer
Example401
404

Not Found

object
status
integer
Example404
description
string
ExampleSummary request not found. The action_id may be invalid or expired.
response_time
string (date-time)
Example2025-12-14T07:26:35.975Z
500

Internal server error

object
error
string
ExampleInternal server error occurred
status
integer
Example500