Skip to main content
PATCH
Update a text 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

textOverlayId
string
required

Text overlay ID

Body

application/json

Update an existing text overlay

background
object

Background behind a text overlay, in the same object shape as a clip background.

backgroundShape
enum<string>

Shape of the solid background behind the text.

Available options:
none,
regular,
squircle
Example:

"squircle"

color
string

Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.

Pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
Example:

"#FFFFFFFF"

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
fontFamily
enum<string>

One of Tella's catalog font families — the same list the editor's font picker offers.

Available options:
Inter,
Roboto Mono,
Archivo,
Barlow,
Caveat,
DM Sans,
Figtree,
Lora,
Merriweather,
Montserrat,
Nunito Sans,
Open Sans,
Oswald,
Playfair Display,
Poppins,
Raleway,
Roboto,
Roboto Flex,
Source Sans 3,
Space Grotesk
Example:

"Inter"

fontSize
number

Font size in artboard pixels.

Required range: x > 0
fontWeight
number
Required range: 1 <= x <= 1000
fontWidth
number
Required range: x > 0
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
text
string
Minimum string length: 1
textAlign
enum<string>

Horizontal alignment of the text inside its overlay box.

Available options:
left,
center,
right
Example:

"center"

Response

OK

A text overlay on a clip

textOverlay
object
required

A text overlay on a clip. Unlike image and video overlays it references no source — the copy and its font live on the overlay itself.