Update a text overlay
Update a text overlay’s copy, font, color, timing, position, or dimensions. Only the fields you send are changed.
Authorizations
API key obtained from your Tella account settings
Path Parameters
Video ID
Clip ID
Text overlay ID
Body
Update an existing text overlay
Background behind a text overlay, in the same object shape as a clip background.
Shape of the solid background behind the text.
none, regular, squircle "squircle"
Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.
^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$"#FFFFFFFF"
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.
0 < x <= 9007199254740991One of Tella's catalog font families — the same list the editor's font picker offers.
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 "Inter"
Font size in artboard pixels.
x > 01 <= x <= 1000x > 0Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.
Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.
0 <= x <= 90071992547409911Horizontal alignment of the text inside its overlay box.
left, center, right "center"
Response
OK
A text overlay on a clip
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.