MAmartinopiaggi

Summarize a source

Changed on

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

  • Base URL
    http://localhost:8000
  • Auth
    none declared

Request body

sourcestring required

Video URL or file path

type'YouTube Video' | 'Video URL' | 'Google Drive Video Link' | 'Dropbox Video Link' | 'Local File' | 'TXT' nullable

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 the configured HTTP 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

sidecar'none' | 'transcriptfetch' nullable

Transcript sidecar for video URLs

sidecar_order'fallback' | 'first' nullable

fallback: after local transcription fails; first: before it

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

Changes

  • 5e719983a908Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • abf737f34b72Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property