Skip to main content
Zoom into a specific point on the clip’s screen layer for a time range (the camera is unaffected). Use manualZoom for a fixed focus point or trackingZoom to follow the cursor in the screen recording.
All times are milliseconds on the clip’s playback timeline — the video as watched, with cuts applied. It is the same timeline as get_transcript, thumbnails, and previews, so nothing needs converting. A start at or past the end of the clip is rejected with a 400.

​
list_zooms

List zooms on a clip.
​
string
required
Video ID
​
string
required
Clip ID

​
add_zoom

Add a zoom to a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
enum<string>
required
manualZoom or trackingZoom
​
integer
required
Start time in ms
​
integer
required
Duration in ms
​
object
Required for manualZoom (rejected if missing); ignored for trackingZoom. Percentages — {xPct, yPct} (0-100).
​
number
required
Magnification factor (1 = no zoom, 3.5 = max). A zoom without a scale cannot be rendered.

​
update_zoom

Update an existing zoom. Only provided fields change.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Zoom ID
​
enum<string>
manualZoom or trackingZoom
​
integer
New start time in ms
​
integer
New duration
​
object
New focus point
​
number
New magnification

​
remove_zoom

Remove a zoom from a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Zoom ID

​
generate_auto_zooms

Automatically generate tracking zooms from the mouse clicks in the clip’s screen recording — the same as the editor’s “Generate zooms”. Every click opens a zoom window; nearby windows are merged. Requires the clip to contain a screen recording; returns an empty list when it has no usable mouse clicks.
By default this removes the clip’s existing tracking zooms first, so repeated calls regenerate instead of stacking. Pass replaceExisting: false to keep them. Manual zooms are never touched.
​
string
required
Video ID
​
string
required
Clip ID
​
enum<string>
How aggressively to zoom — slow, medium (default), or fast. slow opens fewer, longer windows; fast opens shorter, tighter ones at a higher scale.
​
number
Override the magnification factor (1 = no zoom, 3.5 = max). Defaults to the intensity preset’s scale (1.5 for slow/medium, 2 for fast).
​
boolean
Defaults to true — existing tracking zooms are removed first. Pass false to keep them.