Skip to main content
POST
/
agents
/
{agent_id}
/
transcripts
/
{session_id}
/
summarize
Summarize Transcript
curl --request POST \
  --url https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/{agent_id}/transcripts/{session_id}/summarize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "action_items": [
    "Send confirmation email"
  ],
  "call_type": "support",
  "key_moments": [
    "Agent offered a 10% credit which resolved the issue"
  ],
  "outcome": "resolved",
  "sentiment": {
    "agent_performance": "Agent handled the situation professionally",
    "customer_satisfaction": "Customer was satisfied with the resolution",
    "overall": "positive",
    "score": 0.7
  },
  "summary": "Customer called about a billing issue. Agent resolved it by applying a credit.",
  "topics": [
    "billing",
    "account credit"
  ]
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required
session_id
string<uuid>
required

Query Parameters

include_sentiment
boolean
default:true

Include sentiment analysis

include_topics
boolean
default:true

Extract main topics

include_action_items
boolean
default:true

Extract action items

max_summary_length
integer
default:300

Maximum summary length in words

Required range: 50 <= x <= 1000

Response

Successful Response

AI-generated transcript summary and analysis.

summary
string
required

Concise summary of the conversation

sentiment
SentimentAnalysis · object | null

Sentiment analysis

topics
string[]

Main topics discussed

action_items
string[]

Follow-up actions identified

key_moments
string[]

Key moments in the conversation

outcome
string | null

Call outcome: resolved, escalated, etc.

call_type
string | null

Type of call: support, sales, inquiry, etc.