Sign in

v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB
Download-asynchronous

Request asynchronous download

Creates an asynchronous download request for a specific video

post/download-async/{video_external_id}

Path parameters

video_external_idstring required
Example:abc123-def456-ghi789

Unique external video ID

Request body

quality'240p' | '360p' | '480p' | '720p' | '1080p' | '2160p' | 'original' required

File quality

format'video' | 'audio' required

File format

language'pt-BR' | 'en' | 'en-UK' | 'es' | 'es-MX' | 'fr' | 'fr-CA' | 'de' | 'it' | 'it-CH' | 'ja' | 'ru' | 'vi' | 'zh' | 'zh-TW' | 'ar' | 'ko' | 'nl' | 'pl' | 'hi' | 'th' | 'tr' | 'id' | 'sv' | 'no' | 'ro' | 'el' | 'cs' | 'hu' | 'ms' | 'bg' | 'fil' | 'pt' | 'fi' | 'hr' | 'sk' | 'uk' | 'ta' | 'sw' | 'sr' | 'ur' | 'default' required

Content language

video_titlestring required

Optional video title for the download

Example request

{
  "quality": "1080p",
  "format": "video",
  "language": "pt-BR",
  "video_title": "My Video Title"
}

Response

Download created successfully

video_external_idstring

External video ID

resolutionstring

Video resolution

status'enqueued' | 'running' | 'ready' | 'failed'

Current download status

languagestring

Content language

percentageinteger

Processing completion percentage

urlstring uri nullable

Download URL (only available when status = ready)

video_titlestring

Video title

timeRemaininginteger

Estimated time remaining in seconds

Example response

{
  "video_external_id": "abc123-def456-ghi789",
  "resolution": "1080p",
  "status": "enqueued",
  "language": "pt-BR",
  "url": "https://s3.amazonaws.com/bucket/video.mp4?signature=...",
  "video_title": "My Video Title",
  "timeRemaining": 120
}