Skip to main content
POST
Add an overlay 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 an image or video overlay to a clip. Upload the bytes via POST /v1/sources (kind: image or kind: video) and pass the sourceId; the overlay type follows the source's kind. When point/dimensions are omitted, a centered box is computed from the source.

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

5000

sourceId
string
required

Source ID from POST /v1/sources (kind: image or kind: video). The overlay type follows the source's kind.

Example:

"su_abc123"

startTimeMs
integer
required

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

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

1000

dimensions
object

Overlay size in artboard pixels. Absolute (not a percentage) so the overlay shape never distorts when the artboard dimensions change.

name
string
Example:

"Logo"

point
object

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

Response

OK

An overlay on a clip

overlay
object
required

An image or video overlay on a clip.