Videos APIGuides

Update subtitle

Toggle subtitles and style the caption text; the track file itself is read-only.

The subtitle group turns captions on, exposes the toggle to the viewer, and styles the caption text. The track itself — the file with the actual captions — is read-only here.

This is a merge-patch: send only the keys you want to change and everything else keeps its stored value.

Style the captions

curl -X PATCH https://api.vturb.com/v1/videos/{id} \
  -H "Authorization: Bearer vt_..." \
  -H "Content-Type: application/json" \
  -d '{ "subtitle": { "enabled": true, "style": { "font_size": "18px", "color": "#FFFFFF", "text_align": "center" } } }'

The keys

KeyTypeWrites
enabledbooleanTurns subtitles on or off
controlbooleanShows the subtitle toggle on the player
style.font_sizestringCaption font size, e.g. 18px
style.colorstringCaption text color
style.background_colorstringColor behind the caption text
style.text_alignstringleft, center or right
style.show_by_defaultbooleanStart with captions visible

track (name, url) and the layout leaves style.bottom and style.max_width appear on GET but are read-only — patches to them are ignored.

On this page