Skip to main content
Mask a rectangular region of the clip’s screen layer to either blur it (hide sensitive info) or highlight it (draw attention). Both share the same shape: a rectangle defined by a top-left point and dimensions, both in percentages, plus an optional intensity from 0 to 1:
  • For a blur, intensity scales the blur strength — 0 is the standard blur, 1 is three times as heavy. The content stays fully hidden at every value.
  • For a highlight, it sets how dark the area outside the highlight goes — 0 is no dimming, 1 is black. Defaults to 0.7.
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_blurs

List blur masks on a clip.
​
string
required
Video ID
​
string
required
Clip ID

​
add_blur

Add a blur mask to a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
integer
required
Start time in ms
​
integer
required
Duration in ms
​
object
required
Top-left corner — {xPct, yPct} (0-100)
​
object
required
Rectangle size — {widthPct, heightPct} (0-100)
​
number
Blur strength (0-1). 0 is the standard blur, 1 blurs three times as heavily. Defaults to 0.

​
update_blur

Update an existing blur.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Mask ID
​
integer
New start time in ms
​
integer
New duration
​
object
New top-left
​
object
New size
​
number
New blur strength (0-1)

​
remove_blur

Remove a blur from a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Mask ID

​
list_highlights

List highlight masks on a clip.
​
string
required
Video ID
​
string
required
Clip ID

​
add_highlight

Add a highlight mask to a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
integer
required
Start time in ms
​
integer
required
Duration in ms
​
object
required
Top-left corner — {xPct, yPct} (0-100)
​
object
required
Rectangle size — {widthPct, heightPct} (0-100)
​
number
How dark the area outside the highlight goes (0-1, 1 is black). Defaults to 0.7.

​
update_highlight

Update an existing highlight.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Mask ID
​
integer
New start time in ms
​
integer
New duration
​
object
New top-left
​
object
New size
​
number
New dimming level outside the highlight (0-1)

​
remove_highlight

Remove a highlight from a clip.
​
string
required
Video ID
​
string
required
Clip ID
​
string
required
Mask ID