Update smart autoplay
Enable the muted-autoplay overlay and pick its template and position.
Smart autoplay starts the video muted and lays an unmute overlay on top. The write is selection-only: you pick a template and where it sits on the player's 3×3 grid, and the API builds the overlay from that preset.
This is a merge-patch: send only the keys you want to change and everything else keeps its stored value.
Pick a template
curl -X PATCH https://api.vturb.com/v1/videos/{id} \
-H "Authorization: Bearer vt_..." \
-H "Content-Type: application/json" \
-d '{ "smart_autoplay": { "enabled": true, "variants": [ { "template_name": "modern", "template_position": "middle-center" } ] } }'Use your own image
Set template_name to image to overlay a picture you uploaded instead of a
preset. First upload the image through POST /v1/files, then
reference the returned id with file_id and pick a scale between 0.1 and 1.
The API sizes the picture to its own dimensions, shrinks it to fit inside the
player (leaving a margin), applies your scale to that fitted size, and anchors
it to template_position.
curl -X PATCH https://api.vturb.com/v1/videos/{id} \
-H "Authorization: Bearer vt_..." \
-H "Content-Type: application/json" \
-d '{ "smart_autoplay": { "variants": [ { "template_name": "image", "template_position": "top-right", "file_id": "0190a0b0-0000-7000-8000-000000000001", "scale": 0.5 } ] } }'The keys
| Key | Type | Writes |
|---|---|---|
enabled | boolean | Turns smart autoplay on or off |
variants[].template_name | string | One of default, discrete, modern, sightcare, fullscreen, or image for your own picture |
variants[].template_position | string | Grid slot: top/middle/bottom × left/center/right, e.g. middle-center |
variants[].file_id | string | image only — the id of an uploaded image file |
variants[].scale | number | image only — size relative to the fitted picture, 0.1 to 1 |
An unknown template or position is a 422 unprocessable_content. For an image
variant, a missing or non-image file_id, or a scale outside 0.1–1, is a
422 too.
GET may also return mode and active_number — those describe the A/B
experiment the platform runs across variants and are read-only. A variant that
was hand-sculpted on the dashboard (not built from a preset) renders its full
object instead of the two selection keys.