v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0271131.8 KB

Summarize a source

Summarize a video from a URL or file path. All fields from the CLI are supported. The response includes the generated summary in the requested format (markdown, json, or html).

post/summarize

Request body

sourcestring required

Video URL or file path

Source type

providerstring nullable

Provider name from config

prompt_typestring nullable

Summary style

chunk_sizeinteger nullable

Characters per chunk

parallel_callsinteger nullable

Concurrent API requests

max_tokensinteger nullable

Max output tokens per chunk

languagestring nullable

Caption/transcription language

output_languagestring nullable

Summary output language

force_downloadboolean

Skip captions, download audio

transcription'Cloud Whisper' | 'Local Whisper' nullable

Cloud Whisper or Local Whisper

whisper_model'tiny' | 'base' | 'small' | 'medium' | 'large' nullable

Whisper model size

speednumber nullable

Playback speed for audio preprocessing or visual-mode video

output_format'markdown' | 'json' | 'html' nullable

markdown, json, or html

visualboolean

Send video directly to vision model

use_proxyboolean nullable

Route through Webshare proxy

api_keystring nullable

Override API key

base_urlstring nullable

Override API base URL

modelstring nullable

Override model name

cobalt_urlstring nullable

Cobalt base URL

verboseboolean

Verbose progress output

Response

Successful Response

successboolean required

sourcestring required

summarystring required

formatstring required

modelstring nullable

prompt_typestring nullable

processing_time_secondsnumber required

errorstring nullable

error_typestring nullable