Skip to main content
GET
Fetch a video

Authorizations

Authorization
string
header
required

Paste your VTurb API token (vt_...). Sent as Authorization: Bearer <token>.

Path Parameters

id
string
required

Response

The video with its configuration set.

id
string
required
name
string
required
description
string
required
folder_id
string
required
status
string
required
controls
object
required
call_actions
object
required
alternative_video
object
required
traffic_filter
object
required

The gate in front of the video: a viewer who fails any rule is served fallback_video_id instead. It does nothing unless enabled is true and that fallback is set.

styles
object
required

The player's base look: brand color, text/icon color over it, corner radius in pixels, optional gradient. Colors are CSS strings kept exactly as sent.

general
object
required

Standalone settings: currency for revenue metrics, pitch_time the second the offer is made, preload_type the loading screen, start_quality the starting rendition.

immersive_mode
object
required
mini_hooks
object
required

Timed overlays drawn on top of the video — artwork and countdowns with a schedule. With enabled off the player draws nothing.

pixels
object
required

Third-party tracking the player fires while the video plays. enabled gates the whole object — with it off the player fires nothing, whatever items holds.

playback
object
required
subtitle
object
required
thumbsniper
object
required

Still images shown whenever no frame is playing, plus timed cards on top. Not the video's own thumbnail, which is set apart from these.

turbo
single · object
required

Playback speed the player applies on its own instead of leaving the viewer at 1x. mode says if the rate is set by hand or under an A/B test; the tabs follow it.

headline
object
required

The copy drawn above the player. Picked by hand or by an A/B test — mode says which, active_number which variant is served.

progress_bar
object
required
resume
object
required

The "keep watching" modal a returning viewer meets. enabled switches it on; everything else applies only while it is on.

smart_autoplay
object
required

The animated preview that plays before the video itself. enabled switches it on; mode says how the served variant is chosen.