Skip to main content
POST
Add a highlight to a clip

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Video identifier

Example:

"vid_abc123def456"

clipId
string
required

Clip identifier

Example:

"cl_xyz789ghi012"

Body

application/json

Add a highlight mask. Targets the footage in the clip's Screen slot at startTimeMs: the screen recording, or b-roll media a layout puts there. Times are in ms on the clip's playback timeline (cuts applied).

dimensions
object
required

Size of the masked rectangle (percentages)

durationMs
integer
required
Required range: 0 < x <= 9007199254740991
Example:

2000

point
object
required

Top-left corner of the masked rectangle (percentages)

startTimeMs
integer
required

Start time in ms on the clip's playback timeline (cuts applied)

Required range: 0 <= x <= 9007199254740991
Example:

1000

cornerRadius
number

Corner radius from 0 to 64, in the clip's corner units (regular is the video's corner radius, 16 by default, and squircle twice that). Overrides the corners preset's radius, so it needs corners regular or squircle (in the request or already set); setting corners without it goes back to the preset's radius. Absent when the preset's radius applies.

Required range: 0 <= x <= 64
Example:

24

corners
enum<string>

How the highlighted area's corners are rounded. auto (the default) follows the clip's corners; the others override it for this highlight. Highlights only.

Available options:
auto,
none,
regular,
squircle
Example:

"regular"

intensity
number

Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three times as heavily; the content stays fully hidden at every value (defaults to 0). Highlight: how dark the area outside the highlight goes, 0 = no dimming, 1 = black (defaults to 0.7).

Required range: 0 <= x <= 1
Example:

0.7

transition
enum<string>

smooth fades the mask in and out, hard_cut pops it. New masks start on hard_cut.

Available options:
smooth,
hard_cut
Example:

"smooth"

Response

OK

A mask on a clip

mask
object
required

A blur or highlight mask on a clip. Times are in ms on the clip's playback timeline (cuts applied). Internally the mask stays anchored to the footage, so it doesn't drift when cuts change later.