Summaries

Get Summary

Retrieve existing summary data with structured insights

Stream Summary

Generate summaries in real-time with live progress

You can summarize YouTube, Vimeo, DailyMotion and private media files (.mp4 and .mp3). More formats will be introduced soon.

Summaries provide structured, time-stamped insights from your media content, available in both default format and compressed key points.

Quick Start
Supported Formats

Generate Transcript

First, ensure you have a transcript by calling /transcripts/stream

Stream Summary

Call /summaries/stream to generate your summary

Retrieve Results

Use /summaries to get the completed summary data

Get summary

GEThttps://videohighlight.com/api-v1/summaries

Path variables

string

required

The video ID for the file.

Show Video ID Examples

YouTube: For https://www.youtube.com/watch?v=65_PmYipnpk, the videoId is: 65_PmYipnpk
Vimeo: For https://vimeo.com/318971562, the videoId is: 318971562
DailyMotion: For https://www.dailymotion.com/video/x8w5pyg, the videoId is: x8w5pyg

Request parameters

string

required

The media type of the video.Options: youtube, vimeo, dailymotion, or private

string

required

The language code of the input audio in ISO-639-1 format.Examples: en, en-US, fr, es

string

required

The type of the summary.Options:

default - Full summary with detailed segments
compressed - Key points only

Response

{
    "summary_id": "EZYkP1VvTMeYaod3wtJE",
    "video_id": "65_PmYipnpk",
    "type": "youtube",
    "video_title": "Steve Jobs - Courage",
    "language_code": "en",
    "summary_type": "default",
    "summary_segments": [
{
    "id": "39f6bcf3-454c-44ea-9f10-6af9a76aaf6d",
    "segment": "#  Apple's Strategy for Success",
    "start_time": 0.0,
    "index": 0
},
{
    "id": "c51abf9d-617b-4ed4-9e3a-d411a6812f49",
    "segment": "In this section, Apple's approach to success through strategic decision-making and technology adoption is discussed.",
    "start_time": -1.0,
    "index": 1
},
{
    "id": "5f42ce0c-1f48-42cd-a448-1c388e10cf8c",
    "segment": "## Apple's Strategic Technological Choices",
    "start_time": -1.0,
    "index": 2
},
{
    "id": "12fb5076-f0bf-4571-a5be-bc5d59d8a98b",
    "segment": "-  Apple's success stems from carefully selecting promising technological advancements to invest in.",
    "start_time": 0.0,
    "index": 3
},
{
    "id": "7bfa8108-f67c-4f07-8b7e-a7884b022b82",
    "segment": "-  Technology progresses through cycles, and Apple focuses on emerging technologies in their prime to minimize effort and maximize impact.",
    "start_time": 29.0,
    "index": 4
},
{
    "id": "a6f7e219-5007-415f-9464-99c6bca653d9",
    "segment": "-  Examples include transitioning from 5-inch floppy disks to 3.5-inch disks with the Mac, being early adopters of USB, and eliminating outdated technologies like floppy drives with the MacBook Air.",
    "start_time": 55.0,
    "index": 5
},
{
    "id": "daa33fd2-714c-4046-8b5c-27f898a69e62",
    "segment": "## Courage in Decision-Making",
    "start_time": -1.0,
    "index": 6
},
{
    "id": "b887c650-e873-4479-b9af-87f7e0e69c03",
    "segment": "-  Apple demonstrates courage by removing outdated features like floppy disk drives despite criticism.",
    "start_time": 81.0,
    "index": 7
},
{
    "id": "ef8443bf-1386-4d45-b6e5-2dcf166865a1",
    "segment": "-  The company prioritizes future-oriented decisions over popular opinion, focusing on what will drive innovation forward.",
    "start_time": 105.0,
    "index": 8
},
{
    "id": "bf060daa-dff8-429e-8558-e95aafa77515",
    "segment": "## Customer-Centric Product Development",
    "start_time": -1.0,
    "index": 10
},
{
    "id": "1c21508c-8290-4e9b-bd75-f3d580ce2ee8",
    "segment": "-  Apple emphasizes certain features in products while omitting others based on market feedback and their vision for creating exceptional products.",
    "start_time": 131.0,
    "index": 11
}
    ],
    "version": 1
}

{
    "id": "unique-segment-id",
    "segment": "Content of the segment",
    "start_time": 0.0,
    "index": 0
}

number

The index of the segment in the summary

number

The start time of the segment in seconds. -1 means that the core concept was not associated with a specific timestamp

Error responses

The summary has been successfully retrieved.

NO_CONTENT

The video has not been summarized yet.

BAD_REQUEST

The request is invalid.

UNAUTHORIZED

The request is unauthorized.

INTERNAL_SERVER_ERROR

The server has encountered an error.

If the video has not been summarized yet, the response will be 204 with no content. Calling the Stream endpoint is required.

Stream summary

POSThttps://videohighlight.com/api-v1/summaries/stream

Current limitation:The summary stream needs to be called AFTER a transcript stream has been called, or the transcript is available.Options:

Call the /transcripts/stream endpoint first, and after a few seconds, call the /summaries/stream endpoint.
Call the /transcripts/stream endpoint and allow the transcript generation to complete. Call the /summaries/stream after the transcript is available.
Ensure that the /transcripts/get endpoint has a non 204 response before calling the /summaries/stream endpoint.

Calling the /summaries/stream endpoint before the transcript is available will not generate a summary.

Request body

string

required

The unique identifier for the video

string

required

The media type of the video. Options: youtube, vimeo, dailymotion, or private

string

required

The language code of the input audio in ISO-639-1 format, like en or fr

string

required

The type of the summary. Options: default (for the default Summary) or compressed (for Key Points)

boolean

required

Whether to use Server-Sent Events for streaming

boolean

required

Whether to regenerate the summary if it already exists

{
    "video_id": "65_PmYipnpk",
    "type": "youtube",
    "language_code": "en",
    "summary_type": "default",
    "use_sse": true,
    "regenerate": false
}

curl -X POST "https://videohighlight.com/api-v1/summaries/stream" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"video_id": "65_PmYipnpk",
"type": "youtube",
"language_code": "en",
"summary_type": "default",
"use_sse": true,
"regenerate": false
}'

Response Types

The streaming endpoint returns different types of messages:

Error Messages

{
    "type": "error",
    "info": {
    "type": "[ERROR-FILE-DOWNLOAD]",
    "message": "This video can not be downloaded."
}
}

{
    "ERROR": "Generic error message",
    "ERROR-FILE-DOWNLOAD": "The video can not be downloaded",
    "ERROR-FILE-DOWNLOAD-TO-ASR": "The video can not be downloaded by the ASR service",
    "ERROR-VIDEO-PRIVATE": "The video is private",
    "ERROR-VIDEO-GEO-RESTRICTION": "The video is not available in your region",
    "ERROR-VIDEO-COPYRIGHT": "The video is copyrighted",
    "ERROR-VIDEO-UNAVAILABLE": "The video is not available",
    "ERROR-GENERIC-STREAMING-EXCEPTION": "Generic error message",
    "ERROR-REMOTE-ASR-CONNECTION": "The ASR service connection has failed",
    "ERROR-REMOTE-ASR-TIMEOUT": "The ASR service connection has timed out",
    "ERROR-UNEXPECTED": "An unexpected error has occurred"
}

Summary Segment Messages

Summary Segment

{
    "type": "segment",
    "info": {
        "id": "95cffeb9-52ed-4e6c-a3af-7bcf6b3bd96a",
        "start_time": 1.34,
        "segment": "Apple is a company that has doesn't have the most resources of everybody in the world and the way we've succeeded is by",
        "index": 1
  }
}

The start_time value of -1 indicates that the core concept was not associated with a specific timestamp.

Semaphore Messages

{
    "type": "semaphore",
    "info": {
    "status": "[DONE]"
}
}

{
    "DONE": "The summary has been successfully generated",
    "INSUFFICIENT_DATA": "Not sufficient data to complete (e.g., video too short)",
    "KEEP_ALIVE": "The summary is still being processed"
}

Summary Info Messages

Summary Info

{
    "type": "summary_info",
    "info": {
        "summary_id": "954zACRVRY6L5DXGPEiQ",
        "video_id": "65_PmYipnpk",
        "type": "youtube",
        "video_title": "Steve Jobs - Courage",
        "language_code": "en"
    }
}

Progress Messages

Progress Update

{
    "type": "summary_progress",
    "info": {
        "progress": 0.37,
        "speed": "",
        "eta": ""
    }
}

The speed and eta fields are currently not used and will return empty strings.

Introduction

Transcripts

Summaries

Get Summary

Stream Summary

Get summary

Path variables

Request parameters

Response

Error responses

Stream summary

Request body

Response Types

Error Messages

Summary Segment Messages

Semaphore Messages

Summary Info Messages

Progress Messages

Get Summary

Stream Summary

​Get summary

​Path variables

​Request parameters

​Response

​Error responses

​Stream summary

​Request body

​Response Types

​Error Messages

​Summary Segment Messages

​Semaphore Messages

​Summary Info Messages

​Progress Messages

Get summary

Path variables

Request parameters

Response

Error responses

Stream summary

Request body

Response Types

Error Messages

Summary Segment Messages

Semaphore Messages

Summary Info Messages

Progress Messages