Skip to main content
PATCH
Update an overlay

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Video ID

clipId
string
required

Clip ID

overlayId
string
required

Overlay ID

Body

application/json

Update an existing overlay

depth
enum<string>

Where the overlay sits relative to the presenter on a clip with a camera layout: front paints over everything, behind_presenter tucks it behind the cut-out presenter but above the clip background and screen. New overlays start on front. Without a camera in the layout the overlay paints in front either way.

Available options:
front,
behind_presenter
Example:

"behind_presenter"

dimensions
object

Overlay size in artboard pixels. Absolute (not a percentage) so the overlay shape never distorts when the artboard dimensions change. Both sides must be greater than 0 — the renderer lays the overlay out into this box, so a zero or negative side has no valid meaning.

durationMs
integer
Required range: 0 < x <= 9007199254740991
name
string
point
object

Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.

startTimeMs
integer

Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.

Required range: 0 <= x <= 9007199254740991
transition
enum<string>

Intro/outro animation: smooth fades the overlay in at its start and out at its end, hard_cut pops it in and out.

Available options:
smooth,
hard_cut
Example:

"smooth"

zIndex
integer

Stacking position among the clip's image, video and text overlays: 0 is the backmost. depth applies first — a behind_presenter overlay stays behind the presenter whatever its zIndex — so the order only matters among overlays at the same depth. Lottie overlays share the stack but aren't listed, so listed values can skip a number. A value past the top moves the overlay to the front; the other overlays keep their relative order.

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

0

Response

OK

An overlay on a clip

overlay
object
required

An image or video overlay on a clip.

Last modified on October 6, 2026