API Documentation

View API Pricing →

Overview

Base URL: http://snap-summary.com/summarize

Method: POST

Response Type: Streaming JSON (text chunks) with Markdown formatting

This endpoint summarises YouTube videos. It can return:

overall: A high-level summary.
detailed-timestamps: Comprehensive summaries split by timestamps.
key-timestamps: Key points summarised by timestamps.
transcript: Full transcript of the video.
search: Search mentions of a term (requires search_term).

Note: Chat with video is not available via this endpoint.

Request

Headers

Content-Type: application/json

Body Parameters

user_id (string): Unique user identifier.
- To obtain a user_id, please contact snapsummary.contact@gmail.com.
- Do not share or reveal your user_id publicly.
url (string): Full video URL.
language (string): Language for summary.
type (string): Summary type. Valid values:
- overall: Full summary.
- detailed-timestamps: Detailed timestamped summary.
- key-timestamps: Key timestamp highlights.
- transcript: Full video transcript.
- search: Requires search_term.
- custom: Requires custom_prompt.
search_term (string): Required only for type=search.
custom_prompt (string): Required only for type=custom.
- key_takeaways - Summarize main takeaways as bullet points.
- quick_overview - TL;DR bullet points for YouTube comments.
- timeline - Chronological event timeline (no timestamps).
- how_to_steps - Step-by-step instructions.
- chapter - Extract up to 10 chapter titles with timestamps.
- eli5 - Explain like I'm 5.
- visual_metaphor - Use visual metaphors.
- definitions_explained - Explain complex terms.
- topic_breakdown - Break down into topics.
- pros_cons - List advantages and disadvantages.
- data_statistics - Extract key numbers and statistics.
- resource_links - Only list mentioned resources (books, websites, etc.).
- related_resources - Suggest further reading.
- faq_highlights - List frequently asked questions.
- question_generator - Generate new questions based on the video.
- key_quotes - Extract significant quotes with timestamps.
- humor_highlights - Highlight humorous moments.

Example Usage with Streaming (Python)

import requests

api_url = "http://snap-summary.com/summarize"

payload = {
"user_id": "YOUR_USER_ID", # contact snapsummary.contact@gmail.com to obtain
"url": "YOUTUBE_URL", # e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ
"language": "LANGUAGE", # e.g. "en", "es", "zh-CN", "hi", "pt", "fr" etc.
"type": "TYPE", # e.g. "overall", "detailed-timestamps", "key-timestamps", "transcript", "search"
"search_term": "",
"custom_prompt": ""
}

headers = {"Content-Type": "application/json"}

response = requests.post(api_url, json=payload, headers=headers, stream=True)
if response.status_code == 200:
    for chunk in response.iter_content(chunk_size=None):
        if chunk:
            print(chunk.decode('utf-8'), end='')
else:
    print(f"Error: {response.status_code} - {response.json().get('error')}")

Example Usage Waiting for Complete Response (Python)

import requests

api_url = "http://snap-summary.com/summarize"

payload = {
"user_id": "YOUR_USER_ID", # contact snapsummary.contact@gmail.com to obtain
"url": "YOUTUBE_URL", # e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ
"language": "LANGUAGE", # e.g. "en", "es", "zh-CN", "hi", "pt", "fr" etc.
"type": "TYPE", # e.g. "overall", "detailed-timestamps", "key-timestamps", "transcript", "search"
"search_term": "",
"custom_prompt": ""
}

headers = {"Content-Type": "application/json"}

response = requests.post(api_url, json=payload, headers=headers)
if response.status_code == 200:
    print(response.text)
else:
    print(f"Error: {response.status_code} - {response.json().get('error')}")

Notes

Check your credit usage on your account dashboard.
Report bugs or issues to snapsummary.contact@gmail.com.