GetTranscriptSummary

GetTranscriptSummary gets a transcript summary for a provided transcript.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

GetTranscriptSummaryRequest is a request for getting a transcript summary.

transcript_sid

integer <int64> | string

transcript_sid

optional

Required - transcript to get summary of.

Example

{
    "transcript_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

GetTranscriptSummaryResponse is a response for getting a transcript summary.

transcript_summary

object (TranscriptSummary)

transcript_summary

optional

TranscriptSummary is an AI generated summary based on a parent transcript.

status

enum<string>

status

optional

Status of the summary.

Allowed values:

TRANSCRIPT_SUMMARY_STATUS_QUEUEDTRANSCRIPT_SUMMARY_STATUS_QUEUED_ERROREDTRANSCRIPT_SUMMARY_STATUS_SUMMARIZEDTRANSCRIPT_SUMMARY_STATUS_SUMMARIZED_ERROREDTRANSCRIPT_SUMMARY_STATUS_VISIBLE

bullet_points

array[string]

bullet_points

optional

Summary content provided in multiple bullet points.

Example

{
    "transcript_summary": {
        "status": "TRANSCRIPT_SUMMARY_STATUS_QUEUED",
        "bullet_points": [
            "string"
        ]
    }
}

🔴500Server Error