{
"docsUrl": "https://docs.tella.com/",
"error": "bad_request",
"message": "The request was malformed or contained invalid parameters."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "unauthorized",
"message": "Authentication is required. Provide a valid API key."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "forbidden",
"message": "You don't have permission to access this resource."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "not_found",
"message": "The requested resource was not found."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "conflict",
"message": "The request conflicts with the resource's current state, e.g. an Idempotency-Key whose first request is still in progress. Retry once it settles."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "rate_limited",
"message": "You have exceeded the rate limit. Please slow down."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "not_implemented",
"message": "The requested operation is not implemented."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "unavailable",
"message": "A dependency was unavailable and the request was not executed. Safe to resend unchanged after the Retry-After delay."
}
Update a shape overlay
Update a shape overlay’s outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.
{
"docsUrl": "https://docs.tella.com/",
"error": "bad_request",
"message": "The request was malformed or contained invalid parameters."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "unauthorized",
"message": "Authentication is required. Provide a valid API key."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "forbidden",
"message": "You don't have permission to access this resource."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "not_found",
"message": "The requested resource was not found."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "conflict",
"message": "The request conflicts with the resource's current state, e.g. an Idempotency-Key whose first request is still in progress. Retry once it settles."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "rate_limited",
"message": "You have exceeded the rate limit. Please slow down."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "not_implemented",
"message": "The requested operation is not implemented."
}
{
"docsUrl": "https://docs.tella.com/",
"error": "unavailable",
"message": "A dependency was unavailable and the request was not executed. Safe to resend unchanged after the Retry-After delay."
}
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
shapeOverlayId
string
required
Shape overlay ID
Body
application/json
Update an existing shape overlay. Only provided fields change.
animation
object | null
Animate how the shape enters and leaves. An omitted intro/outro keeps that side. Null removes the animation, so transition plays again.
Hide child attributes
animation.intro
object | null
How the whole overlay enters, or null to appear instantly. Takes no text. Omit to keep the current intro.
Hide child attributes
animation.intro.blur
number
Blur of the hidden state in pixels.
Required range: 0 <= x <= 200
animation.intro.clip
boolean
Clip the motion to the overlay's box, so it wipes in like a mask.
animation.intro.durationMs
number
How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.
Required range: 50 <= x <= 5000
animation.intro.easing
object
How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.
Hide child attributes
animation.intro.easing.curve
enum<string>
required
How a side accelerates. linear keeps one speed. smooth, natural, slow_down, accelerate, elastic, bounce, overshoot, impulse and swing are shaped by intensity. custom follows bezier, spring follows spring.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
bounce,
overshoot,
impulse,
swing,
custom,
spring
Example:
"slow_down"
animation.intro.easing.bezier
number[]
For custom: the handles. Defaults to the side's current curve.
Required array length: 4 elements
Required range: 0 <= x <= 1
Example:
[0.25, 0.1, 0.25, 1]
animation.intro.easing.intensity
number
How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.
Required range: 0 <= x <= 1
animation.intro.easing.spring
object
For spring: its physics. Defaults to stiffness 200, damping 12, mass 1.
Hide child attributes
animation.intro.easing.spring.damping
number
required
Required range: 1 <= x <= 300
Example:
12
animation.intro.easing.spring.mass
number
required
Required range: 0.1 <= x <= 10
Example:
1
animation.intro.easing.spring.stiffness
number
required
Required range: 1 <= x <= 1000
Example:
200
animation.intro.moveX
number
Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.
Required range: -10 <= x <= 10
animation.intro.moveY
number
Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.
Required range: -10 <= x <= 10
animation.intro.opacity
number
Opacity of the hidden state, 0 to 1.
Required range: 0 <= x <= 1
animation.intro.preset
enum<string>
Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from fade.
Available options:
fade,
slide_up,
slide_down,
slide_left,
slide_right,
mask_up,
mask_down,
grow,
shrink,
blur,
blur_slide_up
Example:
"slide_up"
animation.intro.rotate
number
Clockwise rotation of the hidden state in degrees.
Required range: -3600 <= x <= 3600
animation.intro.scale
number
Scale of the hidden state; 1 is its resting size.
Required range: 0 <= x <= 10
animation.intro.text
object
On textIntro/textOutro only: which units play the side, each in turn. Required on a new text side.
Hide child attributes
animation.intro.text.unit
enum<string>
required
What animates on its own.
Available options:
letters,
words,
lines
Example:
"words"
animation.intro.text.delayMs
number
How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.
Required range: 0 <= x <= 2000
animation.intro.text.order
enum<string>
Which unit goes first. random uses the same shuffle every time. Defaults to forward.
Available options:
forward,
backward,
center,
edges,
random
Example:
"forward"
animation.intro.text.smoothing
enum<string>
Eases the delays across the units. Defaults to linear.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
overshoot,
impulse,
swing
Example:
"linear"
animation.motionBlur
boolean
Blur the overlay along its motion while it moves, scales or turns. Defaults to true.
animation.outro
object | null
How the whole overlay leaves, or null to disappear instantly. Takes no text. Omit to keep the current outro.
Hide child attributes
animation.outro.blur
number
Blur of the hidden state in pixels.
Required range: 0 <= x <= 200
animation.outro.clip
boolean
Clip the motion to the overlay's box, so it wipes in like a mask.
animation.outro.durationMs
number
How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.
Required range: 50 <= x <= 5000
animation.outro.easing
object
How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.
Hide child attributes
animation.outro.easing.curve
enum<string>
required
How a side accelerates. linear keeps one speed. smooth, natural, slow_down, accelerate, elastic, bounce, overshoot, impulse and swing are shaped by intensity. custom follows bezier, spring follows spring.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
bounce,
overshoot,
impulse,
swing,
custom,
spring
Example:
"slow_down"
animation.outro.easing.bezier
number[]
For custom: the handles. Defaults to the side's current curve.
Required array length: 4 elements
Required range: 0 <= x <= 1
Example:
[0.25, 0.1, 0.25, 1]
animation.outro.easing.intensity
number
How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.
Required range: 0 <= x <= 1
animation.outro.easing.spring
object
For spring: its physics. Defaults to stiffness 200, damping 12, mass 1.
Hide child attributes
animation.outro.easing.spring.damping
number
required
Required range: 1 <= x <= 300
Example:
12
animation.outro.easing.spring.mass
number
required
Required range: 0.1 <= x <= 10
Example:
1
animation.outro.easing.spring.stiffness
number
required
Required range: 1 <= x <= 1000
Example:
200
animation.outro.moveX
number
Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.
Required range: -10 <= x <= 10
animation.outro.moveY
number
Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.
Required range: -10 <= x <= 10
animation.outro.opacity
number
Opacity of the hidden state, 0 to 1.
Required range: 0 <= x <= 1
animation.outro.preset
enum<string>
Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from fade.
Available options:
fade,
slide_up,
slide_down,
slide_left,
slide_right,
mask_up,
mask_down,
grow,
shrink,
blur,
blur_slide_up
Example:
"slide_up"
animation.outro.rotate
number
Clockwise rotation of the hidden state in degrees.
Required range: -3600 <= x <= 3600
animation.outro.scale
number
Scale of the hidden state; 1 is its resting size.
Required range: 0 <= x <= 10
animation.outro.text
object
On textIntro/textOutro only: which units play the side, each in turn. Required on a new text side.
Hide child attributes
animation.outro.text.unit
enum<string>
required
What animates on its own.
Available options:
letters,
words,
lines
Example:
"words"
animation.outro.text.delayMs
number
How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.
Required range: 0 <= x <= 2000
animation.outro.text.order
enum<string>
Which unit goes first. random uses the same shuffle every time. Defaults to forward.
Available options:
forward,
backward,
center,
edges,
random
Example:
"forward"
animation.outro.text.smoothing
enum<string>
Eases the delays across the units. Defaults to linear.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
overshoot,
impulse,
swing
Example:
"linear"
animation.textIntro
object | null
Text overlays only: how its letters, words or lines enter, one after another, or null for none. Plays alongside intro: both start together.
Hide child attributes
animation.textIntro.blur
number
Blur of the hidden state in pixels.
Required range: 0 <= x <= 200
animation.textIntro.clip
boolean
Clip the motion to the overlay's box, so it wipes in like a mask.
animation.textIntro.durationMs
number
How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.
Required range: 50 <= x <= 5000
animation.textIntro.easing
object
How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.
Hide child attributes
animation.textIntro.easing.curve
enum<string>
required
How a side accelerates. linear keeps one speed. smooth, natural, slow_down, accelerate, elastic, bounce, overshoot, impulse and swing are shaped by intensity. custom follows bezier, spring follows spring.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
bounce,
overshoot,
impulse,
swing,
custom,
spring
Example:
"slow_down"
animation.textIntro.easing.bezier
number[]
For custom: the handles. Defaults to the side's current curve.
Required array length: 4 elements
Required range: 0 <= x <= 1
Example:
[0.25, 0.1, 0.25, 1]
animation.textIntro.easing.intensity
number
How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.
Required range: 0 <= x <= 1
animation.textIntro.easing.spring
object
For spring: its physics. Defaults to stiffness 200, damping 12, mass 1.
Hide child attributes
animation.textIntro.easing.spring.damping
number
required
Required range: 1 <= x <= 300
Example:
12
animation.textIntro.easing.spring.mass
number
required
Required range: 0.1 <= x <= 10
Example:
1
animation.textIntro.easing.spring.stiffness
number
required
Required range: 1 <= x <= 1000
Example:
200
animation.textIntro.moveX
number
Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.
Required range: -10 <= x <= 10
animation.textIntro.moveY
number
Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.
Required range: -10 <= x <= 10
animation.textIntro.opacity
number
Opacity of the hidden state, 0 to 1.
Required range: 0 <= x <= 1
animation.textIntro.preset
enum<string>
Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from fade.
Available options:
fade,
slide_up,
slide_down,
slide_left,
slide_right,
mask_up,
mask_down,
grow,
shrink,
blur,
blur_slide_up
Example:
"slide_up"
animation.textIntro.rotate
number
Clockwise rotation of the hidden state in degrees.
Required range: -3600 <= x <= 3600
animation.textIntro.scale
number
Scale of the hidden state; 1 is its resting size.
Required range: 0 <= x <= 10
animation.textIntro.text
object
On textIntro/textOutro only: which units play the side, each in turn. Required on a new text side.
Hide child attributes
animation.textIntro.text.unit
enum<string>
required
What animates on its own.
Available options:
letters,
words,
lines
Example:
"words"
animation.textIntro.text.delayMs
number
How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.
Required range: 0 <= x <= 2000
animation.textIntro.text.order
enum<string>
Which unit goes first. random uses the same shuffle every time. Defaults to forward.
Available options:
forward,
backward,
center,
edges,
random
Example:
"forward"
animation.textIntro.text.smoothing
enum<string>
Eases the delays across the units. Defaults to linear.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
overshoot,
impulse,
swing
Example:
"linear"
animation.textOutro
object | null
Text overlays only: how its letters, words or lines leave, one after another, or null for none. Plays alongside outro: both end together.
Hide child attributes
animation.textOutro.blur
number
Blur of the hidden state in pixels.
Required range: 0 <= x <= 200
animation.textOutro.clip
boolean
Clip the motion to the overlay's box, so it wipes in like a mask.
animation.textOutro.durationMs
number
How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.
Required range: 50 <= x <= 5000
animation.textOutro.easing
object
How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.
Hide child attributes
animation.textOutro.easing.curve
enum<string>
required
How a side accelerates. linear keeps one speed. smooth, natural, slow_down, accelerate, elastic, bounce, overshoot, impulse and swing are shaped by intensity. custom follows bezier, spring follows spring.
Available options:
linear,
smooth,
natural,
slow_down,
accelerate,
elastic,
bounce,
overshoot,
impulse,
swing,
custom,
spring
Example:
"slow_down"
animation.textOutro.easing.bezier
number[]
For custom: the handles. Defaults to the side's current curve.
Required array length: 4 elements
Required range: 0 <= x <= 1
Example:
[0.25, 0.1, 0.25, 1]
animation.textOutro.easing.intensity
number
How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.
Required range: 0 <= x <= 1
animation.textOutro.easing.spring
object
For spring: its physics. Defaults to stiffness 200, damping 12, mass 1.
Hide child attributes
animation.textOutro.easing.spring.damping
number
required
Required range: 1 <= x <= 300
Example:
12
animation.textOutro.easing.spring.mass
number
required
Required range: 0.1 <= x <= 10
Example:
1
animation.textOutro.easing.spring.stiffness
number
required
Required range: 1 <= x <= 1000
Example:
200
animation.textOutro.moveX
number
Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.
Required range: -10 <= x <= 10
animation.textOutro.moveY
number
Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.
Required range: -10 <= x <= 10
animation.textOutro.opacity
number
Opacity of the hidden state, 0 to 1.
Required range: 0 <= x <= 1
animation.textOutro.preset
enum<string>
Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from fade.
Available options:
fade,
slide_up,
slide_down,
slide_left,
slide_right,
mask_up,
mask_down,
grow,
shrink,
blur,
blur_slide_up
Example:
"slide_up"
animation.textOutro.rotate
number
Clockwise rotation of the hidden state in degrees.
Required range: -3600 <= x <= 3600
animation.textOutro.scale
number
Scale of the hidden state; 1 is its resting size.
Required range: 0 <= x <= 10
animation.textOutro.text
object
On textIntro/textOutro only: which units play the side, each in turn. Required on a new text side.
Hide child attributes
animation.textOutro.text.unit
enum<string>
required
What animates on its own.
Available options:
letters,
words,
lines
Example:
"words"
animation.textOutro.text.delayMs
number
How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.
Required range: 0 <= x <= 2000
animation.textOutro.text.order
enum<string>
Which unit goes first. random uses the same shuffle every time. Defaults to forward.
Available options:
forward,
backward,
center,
edges,
random
Example:
"forward"
animation.textOutro.text.smoothing
enum<string>
Eases the delays across the units. Defaults to linear.
Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.
Pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
Example:
"#FFFFFFFF"
border.width
number
required
Artboard pixels, drawn inside the outline.
Required range: x > 0
cornerRadius
number | null
The corners' own radius in story pixels, or null for their preset's.
Required range: 0 <= x <= 512
Example:
24
corners
enum<string>
How a square's corners are rounded.
Available options:
none,
regular,
squircle
Example:
"squircle"
depth
enum<string>
Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. front paints over everything. behind_presenter paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on front. Without a presenter the overlay paints in front either way.
Available options:
front,
behind_presenter
Example:
"behind_presenter"
depthChanges
object[]
Changes of depth over the overlay's own time, each held until the next: atMs after the overlay starts it moves to that depth, so one overlay can pass in front of the presenter and back behind them (a ring orbiting their head, a title they step in front of). depth is where it starts. On updates, omit it to leave the changes as they are; [] removes them. Absent in responses while the overlay holds one depth.
Hide child attributes
depthChanges.atMs
number
required
Ms after the overlay starts.
Required range: x >= 0
Example:
1200
depthChanges.depth
enum<string>
required
Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. front paints over everything. behind_presenter paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on front. Without a presenter 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.
Hide child attributes
dimensions.height
number
required
Required range: x > 0
Example:
540
dimensions.width
number
required
Required range: x > 0
Example:
960
durationMs
integer
Required range: 0 < x <= 9007199254740991
fill
object
What fills the shape, cut to its outline: any clip background except ambient. A solid #00000000 leaves only the border.
Hide child attributes
fill.type
enum<string>
required
Background variant. ambient: the clip's screen, else its camera, heavily blurred; no other fields. shaderGradient: an animated gradient set by shaderGradientPreset; echoing a non-preset one unchanged keeps it.
Available options:
solid,
gradient,
image,
video,
shaderGradient,
ambient
Example:
"solid"
fill.color
string | null
Hex color string. Required when type = 'solid'.
Example:
"#000000ff"
fill.gradientAngle
integer | null
Linear gradient angle in degrees. Required when type = 'gradient'.
Required range: -9007199254740991 <= x <= 9007199254740991
Example:
45
fill.gradientColor1
string | null
Hex color string. Required when type = 'gradient'.
Example:
"#ff0080ff"
fill.gradientColor2
string | null
Hex color string. Required when type = 'gradient'.
Example:
"#7928caff"
fill.imageUrl
string<uri> | null
Hosted image URL. Present in responses and accepted as input only when copied exactly from GET /v1/backgrounds; otherwise pass sourceId.
fill.shaderGradientPreset
string | null
Animated gradient preset from GET /v1/backgrounds. Required when type = 'shaderGradient'.
Example:
"Halo"
fill.sourceId
string | null
Source ID from POST /v1/sources (kind: image for type = 'image', kind: video for type = 'video'). Required for image/video backgrounds unless using an exact URL from GET /v1/backgrounds. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.
Example:
"su_abc123"
fill.videoDurationSeconds
number | null
Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.
Required range: x >= 0
Example:
12.4
fill.videoUrl
string<uri> | null
Hosted video URL. Present in responses and accepted as input only when copied exactly from GET /v1/backgrounds; otherwise pass sourceId.
path
string
A custom outline as SVG path data (d) in a 0–100 box; it stretches with the overlay box. Sending it makes the shape a path. Closed subpaths (ending in Z) are filled; an open path shows only its border, drawn centred on the line.
Required string length: 1 - 10000
Example:
"M50 0 L100 100 L0 100 Z"
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.
Hide child attributes
point.xPct
number
required
Example:
30
point.yPct
number
required
Example:
30
shadow
enum<string>
Drop shadow, matching the editor's Shadow menu. It falls from the background box when the text has one, else from the letters.
Available options:
none,
subtle,
deep
Example:
"subtle"
shapeType
enum<string>
The outline, stretched to fill the overlay box: a non-square box makes a rectangle or an oval. path draws the overlay's own path.
Available options:
square,
circle,
triangle,
diamond,
star,
hexagon,
arrow,
path
startTimeMs
integer
Start time. Milliseconds on the clip playback timeline (with cuts applied).
Required range: 0 <= x <= 9007199254740991
transition
enum<string>
Intro/outro animation: smooth fades the shape in and out, hard_cut pops it. An animation replaces it while set; setting transition without animation removes the animation.
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
A shape overlay on a clip
shapeOverlay
object
required
A shape overlay on a clip: a square, circle, star… filled with any clip background.
Hide child attributes
shapeOverlay.border
object | null
required
Hide child attributes
shapeOverlay.border.color
string
required
Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.
Pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
Example:
"#FFFFFFFF"
shapeOverlay.border.width
number
required
Artboard pixels, drawn inside the outline.
Required range: x > 0
shapeOverlay.cornerRadius
number | null
required
The corners' own radius in story pixels, or null for their preset's.
Required range: 0 <= x <= 512
Example:
24
shapeOverlay.corners
enum<string>
required
How a square's corners are rounded.
Available options:
none,
regular,
squircle
Example:
"squircle"
shapeOverlay.depth
enum<string>
required
Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. front paints over everything. behind_presenter paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on front. Without a presenter the overlay paints in front either way.
Available options:
front,
behind_presenter
Example:
"behind_presenter"
shapeOverlay.dimensions
object
required
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.
Hide child attributes
shapeOverlay.dimensions.height
number
required
Required range: x > 0
Example:
540
shapeOverlay.dimensions.width
number
required
Required range: x > 0
Example:
960
shapeOverlay.durationMs
number
required
Required range: x >= 0
shapeOverlay.fill
object
required
What fills the shape, cut to its outline.
Hide child attributes
shapeOverlay.fill.type
enum<string>
required
Background variant. ambient: the clip's screen, else its camera, heavily blurred; no other fields. shaderGradient: an animated gradient set by shaderGradientPreset; echoing a non-preset one unchanged keeps it.
Available options:
solid,
gradient,
image,
video,
shaderGradient,
ambient
Example:
"solid"
shapeOverlay.fill.color
string | null
Hex color string. Required when type = 'solid'.
Example:
"#000000ff"
shapeOverlay.fill.gradientAngle
integer | null
Linear gradient angle in degrees. Required when type = 'gradient'.
Required range: -9007199254740991 <= x <= 9007199254740991
Example:
45
shapeOverlay.fill.gradientColor1
string | null
Hex color string. Required when type = 'gradient'.
Example:
"#ff0080ff"
shapeOverlay.fill.gradientColor2
string | null
Hex color string. Required when type = 'gradient'.
Example:
"#7928caff"
shapeOverlay.fill.imageUrl
string<uri> | null
Hosted image URL. Present in responses and accepted as input only when copied exactly from GET /v1/backgrounds; otherwise pass sourceId.
shapeOverlay.fill.shaderGradientPreset
string | null
Animated gradient preset from GET /v1/backgrounds. Required when type = 'shaderGradient'.
Example:
"Halo"
shapeOverlay.fill.sourceId
string | null
Source ID from POST /v1/sources (kind: image for type = 'image', kind: video for type = 'video'). Required for image/video backgrounds unless using an exact URL from GET /v1/backgrounds. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.
Example:
"su_abc123"
shapeOverlay.fill.videoDurationSeconds
number | null
Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.
Required range: x >= 0
Example:
12.4
shapeOverlay.fill.videoUrl
string<uri> | null
Hosted video URL. Present in responses and accepted as input only when copied exactly from GET /v1/backgrounds; otherwise pass sourceId.
shapeOverlay.id
string
required
Shape overlay ID
Example:
"ly_abc123"
shapeOverlay.name
string | null
required
shapeOverlay.path
string | null
required
SVG path data in a 0–100 box, for shapeType path; null otherwise.
shapeOverlay.point
object
required
Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.
Hide child attributes
shapeOverlay.point.xPct
number
required
Example:
30
shapeOverlay.point.yPct
number
required
Example:
30
shapeOverlay.shadow
enum<string>
required
Drop shadow, matching the editor's Shadow menu. It falls from the background box when the text has one, else from the letters.
Available options:
none,
subtle,
deep
Example:
"subtle"
shapeOverlay.shapeType
enum<string>
required
The outline, stretched to fill the overlay box: a non-square box makes a rectangle or an oval. path draws the overlay's own path.
Available options:
square,
circle,
triangle,
diamond,
star,
hexagon,
arrow,
path
shapeOverlay.startTimeMs
number
required
Required range: x >= 0
shapeOverlay.transition
enum<string>
required
How one thing gives way to the next: smooth eases across the change, hard_cut swaps instantly.
Available options:
smooth,
hard_cut
Example:
"smooth"
shapeOverlay.zIndex
integer
required
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.
Required range: 0 <= x <= 9007199254740991
Example:
0
shapeOverlay.depthChanges
object[]
Changes of depth over the overlay's own time, each held until the next: atMs after the overlay starts it moves to that depth, so one overlay can pass in front of the presenter and back behind them (a ring orbiting their head, a title they step in front of). depth is where it starts. On updates, omit it to leave the changes as they are; [] removes them. Absent in responses while the overlay holds one depth.
Hide child attributes
shapeOverlay.depthChanges.atMs
number
required
Ms after the overlay starts.
Required range: x >= 0
Example:
1200
shapeOverlay.depthChanges.depth
enum<string>
required
Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. front paints over everything. behind_presenter paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on front. Without a presenter the overlay paints in front either way.
Available options:
front,
behind_presenter
Example:
"behind_presenter"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Tella","colors":{"primary":"#8278FA","light":"#B1AAFC","dark":"#5E51F8"},"logo":{"light":"https://mintcdn.com/tella/znRZoQ3e3rlGBTT2/logo-light.svg?fit=max\u0026auto=format\u0026n=znRZoQ3e3rlGBTT2\u0026q=85\u0026s=dd044b03efe593b53353a039bfb31fbf","dark":"https://mintcdn.com/tella/znRZoQ3e3rlGBTT2/logo-dark.svg?fit=max\u0026auto=format\u0026n=znRZoQ3e3rlGBTT2\u0026q=85\u0026s=88323f6b0165ce29c00e3a1d80c82fe3"},"favicon":"https://mintcdn.com/tella/munSRGpiNeMNXMvc/favicon.svg?fit=max\u0026auto=format\u0026n=munSRGpiNeMNXMvc\u0026q=85\u0026s=1b25a4dc5d9a41a1a9238eda432a0cb6","api":{"params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"all","prefill":true},"url":"full","mdx":{"auth":{"method":"bearer"}}},"navbar":{"primary":{"type":"button","label":"Open Tella","href":"https://www.tella.com/videos"}},"footer":{"socials":{"github":"https://github.com/tellahq","x":"https://x.com/tellahq","linkedin":"https://linkedin.com/company/tellahq","youtube":"https://youtube.com/@tellahq","website":"https://tella.com","instagram":"https://instagram.com/tellahq"},"links":[{"header":"Tella features","items":[{"label":"Video trimming","href":"https://www.tella.com/features/video-trimming"},{"label":"Viewer downloads","href":"https://www.tella.com/features/viewer-download"},{"label":"4K export","href":"https://www.tella.com/features/4k-export"},{"label":"AI editing","href":"https://www.tella.com/features/ai-editing"},{"label":"Custom branding","href":"https://www.tella.com/features/custom-branding"},{"label":"Upload video","href":"https://www.tella.com/features/video-upload"},{"label":"Video clips","href":"https://www.tella.com/features/clips"},{"label":"Custom backgrounds","href":"https://www.tella.com/features/custom-backgrounds"},{"label":"All features","href":"https://www.tella.com/features"}]}]},"seo":{"paths":[{"path":"help","metatags":{"canonical":"https://www.tella.com"}},{"path":"changelog","metatags":{"canonical":"https://www.tella.com"}}]},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":false},"contextual":{"options":["copy","assistant","view","chatgpt","claude","perplexity","grok","mcp","add-mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"metadata":{"timestamp":true},"markdown":{"schema":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"anchor":"Community","icon":"users","href":"https://community.tella.tv"},{"anchor":"System Status","icon":"signal","href":"https://status.tella.com"},{"anchor":"Contact Support","icon":"envelope","href":"mailto:support@tella.com"},{"anchor":"Debug","icon":"bug","href":"/help/support/debug-camera-and-microphone-issues"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tella","hasAudioNarration":false,"actualSubdomain":"tella","customDomains":["www.tella.com"],"gitSource":{"type":"github","owner":"tellahq","repo":"tella-fusion","deployBranch":"main","contentDirectory":"packages/core/webapp/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"contextualFeedback":{"allowEmail":true},"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00ef34c953c2aa6bb620f0","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Help Center","count":272},{"language":"default","tag":"Developers","count":216},{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Edit","count":75},{"language":"default","tag":"Clips","count":63},{"language":"default","tag":"Share and embed","count":41},{"language":"default","tag":"Videos","count":40},{"language":"default","tag":"MCP Tools","count":35},{"language":"default","tag":"Troubleshooting and support","count":33},{"language":"default","tag":"Account and workspace","count":31}],"searchSettings":{"isFiltersEnabled":true,"maxResults":15,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"type":"email","email":"support@tella.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/clips/update-a-shape-overlay","slug":"/api-reference/clips/update-a-shape-overlay","pageMetadata":{"title":"Update a shape overlay","description":"Update a shape overlay's outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/shape-overlays/{shapeOverlayId}","href":"/api-reference/clips/update-a-shape-overlay","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update a shape overlay’s outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Update a shape overlay","description":"Update a shape overlay's outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/shape-overlays/{shapeOverlayId}","href":"/api-reference/clips/update-a-shape-overlay","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tella/0df50391d431fa00/support-chat.js","/docs/_mintlify/custom/tella/7e6fe091e3982139/lettervisit.js"],"openApiReferenceData":{"operation":{"description":"Update a shape overlay's outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.","operationId":"updateClipShapeOverlay","parameters":["8bee9815-94c3-4f85-b6ce-375fba2188be","383940b0-5939-4417-a4e0-4ea2653f0481","4c5d10e8-375a-48f6-8fcc-dd91b3083157"],"requestBody":"07099c8b-10b7-4d82-a49b-c599550e533b","responses":{"200":"12f3258b-494c-422f-bf13-405bab335597","400":"26ff4aea-8819-4b99-8498-5023d0c9b29f","401":"af6eb1a6-7789-4e93-9a8b-4a7f7a2b505e","403":"cc435654-487d-46a8-93d6-dcbff635b64f","404":"767cfe20-015d-4721-8d41-3f170fcfe832","409":"23a6be44-2af5-48a1-99d9-f2f09ac1f360","429":"c3d832c9-d440-446e-97d3-fa23b98d195a","500":"ca48c1eb-f116-43a8-85a6-3c5c5da41994","501":"53523528-625e-4a4f-b204-5cfc642f72af","503":"e2a010ab-c424-46ba-9993-046a3d2dcb3f"},"security":["a5e7e177-9907-4c77-b513-83924c5db48f"],"summary":"Update a shape overlay","tags":["Clips"],"method":"patch","type":"path","servers":["d2aabac2-b2bc-4b47-a6f4-a26614a56f79"],"path":"/v1/videos/{id}/clips/{clipId}/shape-overlays/{shapeOverlayId}","baseUrlOptions":["https://api.tella.com"],"title":"Update a shape overlay","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.animation.oneOf.0.intro.oneOf.0.preset":"slide_up","body.animation.oneOf.0.outro.oneOf.0.preset":"fade","body.border.oneOf.0.color":"#FFFFFFFF","body.border.oneOf.0.width":1,"body.cornerRadius.oneOf.0":24,"body.corners":"squircle","body.depth":"behind_presenter","body.depthChanges.items.0.atMs":1200,"body.depthChanges.items.0.depth":"behind_presenter","body.durationMs":4503599627370495,"body.path":"M50 0 L100 100 L0 100 Z","body.shadow":"subtle","body.startTimeMs":4503599627370495,"body.transition":"smooth","body.zIndex":0}],"urlDisplay":"full"},"dependencies":{"parameters":{"8bee9815-94c3-4f85-b6ce-375fba2188be":{"description":"Video ID","in":"path","name":"id","required":true,"schema":{"description":"Video ID","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"383940b0-5939-4417-a4e0-4ea2653f0481":{"description":"Clip ID","in":"path","name":"clipId","required":true,"schema":{"description":"Clip ID","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"4c5d10e8-375a-48f6-8fcc-dd91b3083157":{"description":"Shape overlay ID","in":"path","name":"shapeOverlayId","required":true,"schema":{"description":"Shape overlay ID","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Update an existing shape overlay. Only provided fields change.","minProperties":1,"properties":{"animation":{"oneOf":[{"type":"object","description":"Animate how the shape enters and leaves. An omitted `intro`/`outro` keeps that side. Null removes the animation, so `transition` plays again.","example":{"intro":{"preset":"slide_up"},"outro":{"preset":"fade"}},"properties":{"intro":{"oneOf":[{"type":"object","description":"How the whole overlay enters, or null to appear instantly. Takes no `text`. Omit to keep the current intro.","properties":{"blur":{"description":"Blur of the hidden state in pixels.","maximum":200,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.blur","typeLabel":"number"},"clip":{"description":"Clip the motion to the overlay's box, so it wipes in like a mask.","type":"boolean","uniqueKey":"animation.oneOf.0.intro.oneOf.0.clip","typeLabel":"boolean"},"durationMs":{"description":"How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.","maximum":5000,"minimum":50,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.durationMs","typeLabel":"number"},"easing":{"type":"object","description":"How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.","required":["curve"],"properties":{"curve":{"description":"How a side accelerates. `linear` keeps one speed. `smooth`, `natural`, `slow_down`, `accelerate`, `elastic`, `bounce`, `overshoot`, `impulse` and `swing` are shaped by `intensity`. `custom` follows `bezier`, `spring` follows `spring`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","bounce","overshoot","impulse","swing","custom","spring"],"example":"slow_down","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.curve","typeLabel":"enum\u003cstring>"},"bezier":{"description":"For `custom`: the handles. Defaults to the side's current curve.","example":[0.25,0.1,0.25,1],"items":{"oneOf":[{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier.items.[INDEX].oneOf.0","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier.items.[INDEX].oneOf.3","typeLabel":"number"}],"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier.items.[INDEX]","typeLabel":"number"},"maxItems":4,"minItems":4,"type":"array","uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.bezier","typeLabel":"number[]"},"intensity":{"description":"How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.intensity","typeLabel":"number"},"spring":{"type":"object","description":"For `spring`: its physics. Defaults to stiffness 200, damping 12, mass 1.","required":["stiffness","damping","mass"],"properties":{"damping":{"example":12,"maximum":300,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.spring.damping","typeLabel":"number"},"mass":{"example":1,"maximum":10,"minimum":0.1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.spring.mass","typeLabel":"number"},"stiffness":{"example":200,"maximum":1000,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.spring.stiffness","typeLabel":"number"}},"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing.spring","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.easing","typeLabel":"object"},"moveX":{"description":"Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.moveX","typeLabel":"number"},"moveY":{"description":"Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.moveY","typeLabel":"number"},"opacity":{"description":"Opacity of the hidden state, 0 to 1.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.opacity","typeLabel":"number"},"preset":{"type":"string","description":"Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from `fade`.","enum":["fade","slide_up","slide_down","slide_left","slide_right","mask_up","mask_down","grow","shrink","blur","blur_slide_up"],"example":"slide_up","uniqueKey":"animation.oneOf.0.intro.oneOf.0.preset","typeLabel":"enum\u003cstring>"},"rotate":{"description":"Clockwise rotation of the hidden state in degrees.","maximum":3600,"minimum":-3600,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.rotate","typeLabel":"number"},"scale":{"description":"Scale of the hidden state; 1 is its resting size.","maximum":10,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.scale","typeLabel":"number"},"text":{"type":"object","description":"On `textIntro`/`textOutro` only: which units play the side, each in turn. Required on a new text side.","required":["unit"],"properties":{"unit":{"description":"What animates on its own.","enum":["letters","words","lines"],"example":"words","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.text.unit","typeLabel":"enum\u003cstring>"},"delayMs":{"description":"How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.","maximum":2000,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.intro.oneOf.0.text.delayMs","typeLabel":"number"},"order":{"description":"Which unit goes first. `random` uses the same shuffle every time. Defaults to `forward`.","enum":["forward","backward","center","edges","random"],"example":"forward","type":"string","uniqueKey":"animation.oneOf.0.intro.oneOf.0.text.order","typeLabel":"enum\u003cstring>"},"smoothing":{"description":"Eases the delays across the units. Defaults to `linear`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","overshoot","impulse","swing"],"example":"linear","type":"string","uniqueKey":"animation.oneOf.0.intro.oneOf.0.text.smoothing","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.intro.oneOf.0.text","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.intro.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"animation.oneOf.0.intro.oneOf.1","typeLabel":"null"}],"uniqueKey":"animation.oneOf.0.intro","typeLabel":"object | null"},"motionBlur":{"description":"Blur the overlay along its motion while it moves, scales or turns. Defaults to true.","type":"boolean","uniqueKey":"animation.oneOf.0.motionBlur","typeLabel":"boolean"},"outro":{"oneOf":[{"type":"object","description":"How the whole overlay leaves, or null to disappear instantly. Takes no `text`. Omit to keep the current outro.","properties":{"blur":{"description":"Blur of the hidden state in pixels.","maximum":200,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.blur","typeLabel":"number"},"clip":{"description":"Clip the motion to the overlay's box, so it wipes in like a mask.","type":"boolean","uniqueKey":"animation.oneOf.0.outro.oneOf.0.clip","typeLabel":"boolean"},"durationMs":{"description":"How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.","maximum":5000,"minimum":50,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.durationMs","typeLabel":"number"},"easing":{"type":"object","description":"How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.","required":["curve"],"properties":{"curve":{"description":"How a side accelerates. `linear` keeps one speed. `smooth`, `natural`, `slow_down`, `accelerate`, `elastic`, `bounce`, `overshoot`, `impulse` and `swing` are shaped by `intensity`. `custom` follows `bezier`, `spring` follows `spring`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","bounce","overshoot","impulse","swing","custom","spring"],"example":"slow_down","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.curve","typeLabel":"enum\u003cstring>"},"bezier":{"description":"For `custom`: the handles. Defaults to the side's current curve.","example":[0.25,0.1,0.25,1],"items":{"oneOf":[{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier.items.[INDEX].oneOf.0","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier.items.[INDEX].oneOf.3","typeLabel":"number"}],"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier.items.[INDEX]","typeLabel":"number"},"maxItems":4,"minItems":4,"type":"array","uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.bezier","typeLabel":"number[]"},"intensity":{"description":"How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.intensity","typeLabel":"number"},"spring":{"type":"object","description":"For `spring`: its physics. Defaults to stiffness 200, damping 12, mass 1.","required":["stiffness","damping","mass"],"properties":{"damping":{"example":12,"maximum":300,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.spring.damping","typeLabel":"number"},"mass":{"example":1,"maximum":10,"minimum":0.1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.spring.mass","typeLabel":"number"},"stiffness":{"example":200,"maximum":1000,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.spring.stiffness","typeLabel":"number"}},"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing.spring","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.easing","typeLabel":"object"},"moveX":{"description":"Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.moveX","typeLabel":"number"},"moveY":{"description":"Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.moveY","typeLabel":"number"},"opacity":{"description":"Opacity of the hidden state, 0 to 1.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.opacity","typeLabel":"number"},"preset":{"type":"string","description":"Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from `fade`.","enum":["fade","slide_up","slide_down","slide_left","slide_right","mask_up","mask_down","grow","shrink","blur","blur_slide_up"],"example":"slide_up","uniqueKey":"animation.oneOf.0.outro.oneOf.0.preset","typeLabel":"enum\u003cstring>"},"rotate":{"description":"Clockwise rotation of the hidden state in degrees.","maximum":3600,"minimum":-3600,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.rotate","typeLabel":"number"},"scale":{"description":"Scale of the hidden state; 1 is its resting size.","maximum":10,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.scale","typeLabel":"number"},"text":{"type":"object","description":"On `textIntro`/`textOutro` only: which units play the side, each in turn. Required on a new text side.","required":["unit"],"properties":{"unit":{"description":"What animates on its own.","enum":["letters","words","lines"],"example":"words","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.text.unit","typeLabel":"enum\u003cstring>"},"delayMs":{"description":"How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.","maximum":2000,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.outro.oneOf.0.text.delayMs","typeLabel":"number"},"order":{"description":"Which unit goes first. `random` uses the same shuffle every time. Defaults to `forward`.","enum":["forward","backward","center","edges","random"],"example":"forward","type":"string","uniqueKey":"animation.oneOf.0.outro.oneOf.0.text.order","typeLabel":"enum\u003cstring>"},"smoothing":{"description":"Eases the delays across the units. Defaults to `linear`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","overshoot","impulse","swing"],"example":"linear","type":"string","uniqueKey":"animation.oneOf.0.outro.oneOf.0.text.smoothing","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.outro.oneOf.0.text","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.outro.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"animation.oneOf.0.outro.oneOf.1","typeLabel":"null"}],"uniqueKey":"animation.oneOf.0.outro","typeLabel":"object | null"},"textIntro":{"oneOf":[{"type":"object","description":"Text overlays only: how its letters, words or lines enter, one after another, or null for none. Plays alongside `intro`: both start together.","properties":{"blur":{"description":"Blur of the hidden state in pixels.","maximum":200,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.blur","typeLabel":"number"},"clip":{"description":"Clip the motion to the overlay's box, so it wipes in like a mask.","type":"boolean","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.clip","typeLabel":"boolean"},"durationMs":{"description":"How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.","maximum":5000,"minimum":50,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.durationMs","typeLabel":"number"},"easing":{"type":"object","description":"How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.","required":["curve"],"properties":{"curve":{"description":"How a side accelerates. `linear` keeps one speed. `smooth`, `natural`, `slow_down`, `accelerate`, `elastic`, `bounce`, `overshoot`, `impulse` and `swing` are shaped by `intensity`. `custom` follows `bezier`, `spring` follows `spring`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","bounce","overshoot","impulse","swing","custom","spring"],"example":"slow_down","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.curve","typeLabel":"enum\u003cstring>"},"bezier":{"description":"For `custom`: the handles. Defaults to the side's current curve.","example":[0.25,0.1,0.25,1],"items":{"oneOf":[{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier.items.[INDEX].oneOf.0","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier.items.[INDEX].oneOf.3","typeLabel":"number"}],"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier.items.[INDEX]","typeLabel":"number"},"maxItems":4,"minItems":4,"type":"array","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.bezier","typeLabel":"number[]"},"intensity":{"description":"How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.intensity","typeLabel":"number"},"spring":{"type":"object","description":"For `spring`: its physics. Defaults to stiffness 200, damping 12, mass 1.","required":["stiffness","damping","mass"],"properties":{"damping":{"example":12,"maximum":300,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.spring.damping","typeLabel":"number"},"mass":{"example":1,"maximum":10,"minimum":0.1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.spring.mass","typeLabel":"number"},"stiffness":{"example":200,"maximum":1000,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.spring.stiffness","typeLabel":"number"}},"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing.spring","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.easing","typeLabel":"object"},"moveX":{"description":"Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.moveX","typeLabel":"number"},"moveY":{"description":"Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.moveY","typeLabel":"number"},"opacity":{"description":"Opacity of the hidden state, 0 to 1.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.opacity","typeLabel":"number"},"preset":{"type":"string","description":"Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from `fade`.","enum":["fade","slide_up","slide_down","slide_left","slide_right","mask_up","mask_down","grow","shrink","blur","blur_slide_up"],"example":"slide_up","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.preset","typeLabel":"enum\u003cstring>"},"rotate":{"description":"Clockwise rotation of the hidden state in degrees.","maximum":3600,"minimum":-3600,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.rotate","typeLabel":"number"},"scale":{"description":"Scale of the hidden state; 1 is its resting size.","maximum":10,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.scale","typeLabel":"number"},"text":{"type":"object","description":"On `textIntro`/`textOutro` only: which units play the side, each in turn. Required on a new text side.","required":["unit"],"properties":{"unit":{"description":"What animates on its own.","enum":["letters","words","lines"],"example":"words","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.text.unit","typeLabel":"enum\u003cstring>"},"delayMs":{"description":"How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.","maximum":2000,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.text.delayMs","typeLabel":"number"},"order":{"description":"Which unit goes first. `random` uses the same shuffle every time. Defaults to `forward`.","enum":["forward","backward","center","edges","random"],"example":"forward","type":"string","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.text.order","typeLabel":"enum\u003cstring>"},"smoothing":{"description":"Eases the delays across the units. Defaults to `linear`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","overshoot","impulse","swing"],"example":"linear","type":"string","uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.text.smoothing","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0.text","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textIntro.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"animation.oneOf.0.textIntro.oneOf.1","typeLabel":"null"}],"uniqueKey":"animation.oneOf.0.textIntro","typeLabel":"object | null"},"textOutro":{"oneOf":[{"type":"object","description":"Text overlays only: how its letters, words or lines leave, one after another, or null for none. Plays alongside `outro`: both end together.","properties":{"blur":{"description":"Blur of the hidden state in pixels.","maximum":200,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.blur","typeLabel":"number"},"clip":{"description":"Clip the motion to the overlay's box, so it wipes in like a mask.","type":"boolean","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.clip","typeLabel":"boolean"},"durationMs":{"description":"How long the side plays, in ms (50 to 5000). On a text side, how long each unit plays. Defaults to 500.","maximum":5000,"minimum":50,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.durationMs","typeLabel":"number"},"easing":{"type":"object","description":"How the side accelerates. Without it a new side slows down into place on the way in and speeds up on the way out.","required":["curve"],"properties":{"curve":{"description":"How a side accelerates. `linear` keeps one speed. `smooth`, `natural`, `slow_down`, `accelerate`, `elastic`, `bounce`, `overshoot`, `impulse` and `swing` are shaped by `intensity`. `custom` follows `bezier`, `spring` follows `spring`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","bounce","overshoot","impulse","swing","custom","spring"],"example":"slow_down","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.curve","typeLabel":"enum\u003cstring>"},"bezier":{"description":"For `custom`: the handles. Defaults to the side's current curve.","example":[0.25,0.1,0.25,1],"items":{"oneOf":[{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier.items.[INDEX].oneOf.0","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier.items.[INDEX].oneOf.1","typeLabel":"number"},{"type":"number","maximum":1,"minimum":0,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier.items.[INDEX].oneOf.3","typeLabel":"number"}],"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier.items.[INDEX]","typeLabel":"number"},"maxItems":4,"minItems":4,"type":"array","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.bezier","typeLabel":"number[]"},"intensity":{"description":"How strongly the curve shapes the motion, 0 to 1. Only curves with an intensity use it. Defaults to 0.5.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.intensity","typeLabel":"number"},"spring":{"type":"object","description":"For `spring`: its physics. Defaults to stiffness 200, damping 12, mass 1.","required":["stiffness","damping","mass"],"properties":{"damping":{"example":12,"maximum":300,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.spring.damping","typeLabel":"number"},"mass":{"example":1,"maximum":10,"minimum":0.1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.spring.mass","typeLabel":"number"},"stiffness":{"example":200,"maximum":1000,"minimum":1,"type":"number","isRequired":true,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.spring.stiffness","typeLabel":"number"}},"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing.spring","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.easing","typeLabel":"object"},"moveX":{"description":"Horizontal offset of the hidden state, as a fraction of the overlay's width (of a line's height on a text side); positive is right.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.moveX","typeLabel":"number"},"moveY":{"description":"Vertical offset of the hidden state, as a fraction of the overlay's height (of a line's height on a text side); positive is down.","maximum":10,"minimum":-10,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.moveY","typeLabel":"number"},"opacity":{"description":"Opacity of the hidden state, 0 to 1.","maximum":1,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.opacity","typeLabel":"number"},"preset":{"type":"string","description":"Start from a ready-made side; the other fields adjust it. Without it the side starts from what it is now; a new whole side starts still and a new text side from `fade`.","enum":["fade","slide_up","slide_down","slide_left","slide_right","mask_up","mask_down","grow","shrink","blur","blur_slide_up"],"example":"slide_up","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.preset","typeLabel":"enum\u003cstring>"},"rotate":{"description":"Clockwise rotation of the hidden state in degrees.","maximum":3600,"minimum":-3600,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.rotate","typeLabel":"number"},"scale":{"description":"Scale of the hidden state; 1 is its resting size.","maximum":10,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.scale","typeLabel":"number"},"text":{"type":"object","description":"On `textIntro`/`textOutro` only: which units play the side, each in turn. Required on a new text side.","required":["unit"],"properties":{"unit":{"description":"What animates on its own.","enum":["letters","words","lines"],"example":"words","type":"string","isRequired":true,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.text.unit","typeLabel":"enum\u003cstring>"},"delayMs":{"description":"How long after one unit the next starts, in ms (0 to 2000). Defaults to 100.","maximum":2000,"minimum":0,"type":"number","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.text.delayMs","typeLabel":"number"},"order":{"description":"Which unit goes first. `random` uses the same shuffle every time. Defaults to `forward`.","enum":["forward","backward","center","edges","random"],"example":"forward","type":"string","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.text.order","typeLabel":"enum\u003cstring>"},"smoothing":{"description":"Eases the delays across the units. Defaults to `linear`.","enum":["linear","smooth","natural","slow_down","accelerate","elastic","overshoot","impulse","swing"],"example":"linear","type":"string","uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.text.smoothing","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0.text","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0.textOutro.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"animation.oneOf.0.textOutro.oneOf.1","typeLabel":"null"}],"uniqueKey":"animation.oneOf.0.textOutro","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"animation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"animation.oneOf.1","typeLabel":"null"}],"uniqueKey":"animation","typeLabel":"object | null"},"border":{"oneOf":[{"type":"object","description":"A line just inside the outline, or null for none.","required":["color","width"],"properties":{"color":{"description":"Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.","example":"#FFFFFFFF","pattern":"^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$","type":"string","isRequired":true,"uniqueKey":"border.oneOf.0.color","typeLabel":"string"},"width":{"description":"Artboard pixels, drawn inside the outline.","exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"border.oneOf.0.width","typeLabel":"number"}},"uniqueKey":"border.oneOf.0","typeLabel":"object"},{"type":"null","description":"A line just inside the outline, or null for none.","required":["color","width"],"properties":{"color":{"description":"Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.","example":"#FFFFFFFF","pattern":"^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$","type":"string"},"width":{"description":"Artboard pixels, drawn inside the outline.","exclusiveMinimum":true,"minimum":0,"type":"number"}},"uniqueKey":"border.oneOf.1","typeLabel":"null"}],"uniqueKey":"border","typeLabel":"object | null"},"cornerRadius":{"oneOf":[{"type":"number","description":"The corners' own radius in story pixels, or null for their preset's.","maximum":512,"minimum":0,"example":24,"uniqueKey":"cornerRadius.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"cornerRadius.oneOf.1","typeLabel":"null"}],"uniqueKey":"cornerRadius","typeLabel":"number | null"},"corners":{"type":"string","description":"How a square's corners are rounded.","enum":["none","regular","squircle"],"example":"squircle","uniqueKey":"corners","typeLabel":"enum\u003cstring>"},"depth":{"type":"string","description":"Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. `front` paints over everything. `behind_presenter` paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on `front`. Without a presenter the overlay paints in front either way.","enum":["front","behind_presenter"],"example":"behind_presenter","uniqueKey":"depth","typeLabel":"enum\u003cstring>"},"depthChanges":{"type":"array","items":{"additionalProperties":false,"properties":{"atMs":{"description":"Ms after the overlay starts.","example":1200,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"depthChanges.items.[INDEX].atMs","typeLabel":"number"},"depth":{"description":"Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. `front` paints over everything. `behind_presenter` paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on `front`. Without a presenter the overlay paints in front either way.","enum":["front","behind_presenter"],"example":"behind_presenter","type":"string","isRequired":true,"uniqueKey":"depthChanges.items.[INDEX].depth","typeLabel":"enum\u003cstring>"}},"required":["atMs","depth"],"type":"object","uniqueKey":"depthChanges.items.[INDEX]","typeLabel":"object"},"description":"Changes of `depth` over the overlay's own time, each held until the next: `atMs` after the overlay starts it moves to that depth, so one overlay can pass in front of the presenter and back behind them (a ring orbiting their head, a title they step in front of). `depth` is where it starts. On updates, omit it to leave the changes as they are; `[]` removes them. Absent in responses while the overlay holds one depth.","uniqueKey":"depthChanges","typeLabel":"object[]"},"dimensions":{"type":"object","description":"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.","required":["width","height"],"properties":{"height":{"example":540,"exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"dimensions.height","typeLabel":"number"},"width":{"example":960,"exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"dimensions.width","typeLabel":"number"}},"uniqueKey":"dimensions","typeLabel":"object"},"durationMs":{"exclusiveMinimum":true,"maximum":9007199254740991,"minimum":0,"type":"integer","uniqueKey":"durationMs","typeLabel":"integer"},"fill":{"type":"object","description":"What fills the shape, cut to its outline: any clip background except `ambient`. A solid `#00000000` leaves only the border.","required":["type"],"properties":{"type":{"description":"Background variant. `ambient`: the clip's screen, else its camera, heavily blurred; no other fields. `shaderGradient`: an animated gradient set by `shaderGradientPreset`; echoing a non-preset one unchanged keeps it.","enum":["solid","gradient","image","video","shaderGradient","ambient"],"example":"solid","type":"string","isRequired":true,"uniqueKey":"fill.type","typeLabel":"enum\u003cstring>"},"color":{"oneOf":[{"description":"Hex color string. Required when type = 'solid'.","example":"#000000ff","type":"string","uniqueKey":"fill.color.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'solid'.","example":"#000000ff","type":"null","uniqueKey":"fill.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.color","typeLabel":"string | null"},"gradientAngle":{"oneOf":[{"description":"Linear gradient angle in degrees. Required when type = 'gradient'.","example":45,"maximum":9007199254740991,"minimum":-9007199254740991,"type":"integer","uniqueKey":"fill.gradientAngle.oneOf.0","typeLabel":"integer"},{"description":"Linear gradient angle in degrees. Required when type = 'gradient'.","example":45,"maximum":9007199254740991,"minimum":-9007199254740991,"type":"null","uniqueKey":"fill.gradientAngle.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.gradientAngle","typeLabel":"integer | null"},"gradientColor1":{"oneOf":[{"description":"Hex color string. Required when type = 'gradient'.","example":"#ff0080ff","type":"string","uniqueKey":"fill.gradientColor1.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'gradient'.","example":"#ff0080ff","type":"null","uniqueKey":"fill.gradientColor1.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.gradientColor1","typeLabel":"string | null"},"gradientColor2":{"oneOf":[{"description":"Hex color string. Required when type = 'gradient'.","example":"#7928caff","type":"string","uniqueKey":"fill.gradientColor2.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'gradient'.","example":"#7928caff","type":"null","uniqueKey":"fill.gradientColor2.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.gradientColor2","typeLabel":"string | null"},"imageUrl":{"oneOf":[{"description":"Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"string","uniqueKey":"fill.imageUrl.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"null","uniqueKey":"fill.imageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.imageUrl","typeLabel":"string\u003curi> | null"},"shaderGradientPreset":{"oneOf":[{"description":"Animated gradient preset from `GET /v1/backgrounds`. Required when type = 'shaderGradient'.","example":"Halo","type":"string","uniqueKey":"fill.shaderGradientPreset.oneOf.0","typeLabel":"string"},{"description":"Animated gradient preset from `GET /v1/backgrounds`. Required when type = 'shaderGradient'.","example":"Halo","type":"null","uniqueKey":"fill.shaderGradientPreset.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.shaderGradientPreset","typeLabel":"string | null"},"sourceId":{"oneOf":[{"description":"Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.","example":"su_abc123","type":"string","uniqueKey":"fill.sourceId.oneOf.0","typeLabel":"string"},{"description":"Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.","example":"su_abc123","type":"null","uniqueKey":"fill.sourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.sourceId","typeLabel":"string | null"},"videoDurationSeconds":{"oneOf":[{"description":"Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.","example":12.4,"minimum":0,"type":"number","uniqueKey":"fill.videoDurationSeconds.oneOf.0","typeLabel":"number"},{"description":"Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.","example":12.4,"minimum":0,"type":"null","uniqueKey":"fill.videoDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.videoDurationSeconds","typeLabel":"number | null"},"videoUrl":{"oneOf":[{"description":"Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"string","uniqueKey":"fill.videoUrl.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"null","uniqueKey":"fill.videoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"fill.videoUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"fill","typeLabel":"object"},"path":{"description":"A custom outline as SVG path data (`d`) in a 0–100 box; it stretches with the overlay box. Sending it makes the shape a `path`. Closed subpaths (ending in Z) are filled; an open path shows only its `border`, drawn centred on the line.","example":"M50 0 L100 100 L0 100 Z","maxLength":10000,"minLength":1,"type":"string","uniqueKey":"path","typeLabel":"string"},"point":{"type":"object","description":"Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.","required":["xPct","yPct"],"properties":{"xPct":{"example":30,"type":"number","isRequired":true,"uniqueKey":"point.xPct","typeLabel":"number"},"yPct":{"example":30,"type":"number","isRequired":true,"uniqueKey":"point.yPct","typeLabel":"number"}},"uniqueKey":"point","typeLabel":"object"},"shadow":{"type":"string","description":"Drop shadow, matching the editor's Shadow menu. It falls from the background box when the text has one, else from the letters.","enum":["none","subtle","deep"],"example":"subtle","uniqueKey":"shadow","typeLabel":"enum\u003cstring>"},"shapeType":{"type":"string","description":"The outline, stretched to fill the overlay box: a non-square box makes a rectangle or an oval. `path` draws the overlay's own `path`.","enum":["square","circle","triangle","diamond","star","hexagon","arrow","path"],"uniqueKey":"shapeType","typeLabel":"enum\u003cstring>"},"startTimeMs":{"description":"Start time. Milliseconds on the clip playback timeline (with cuts applied).","maximum":9007199254740991,"minimum":0,"type":"integer","uniqueKey":"startTimeMs","typeLabel":"integer"},"transition":{"type":"string","description":"Intro/outro animation: `smooth` fades the shape in and out, `hard_cut` pops it. An `animation` replaces it while set; setting `transition` without `animation` removes the animation.","enum":["smooth","hard_cut"],"example":"smooth","uniqueKey":"transition","typeLabel":"enum\u003cstring>"},"zIndex":{"description":"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.","example":0,"maximum":9007199254740991,"minimum":0,"type":"integer","uniqueKey":"zIndex","typeLabel":"integer"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"animation":{"intro":{"preset":"slide_up"},"outro":{"preset":"fade"}},"border":{"color":"#FFFFFFFF","width":1},"cornerRadius":24,"corners":"squircle","depth":"behind_presenter","depthChanges":[{"atMs":1200,"depth":"behind_presenter"}],"durationMs":4503599627370495,"path":"M50 0 L100 100 L0 100 Z","shadow":"subtle","startTimeMs":4503599627370495,"transition":"smooth","zIndex":0}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"12f3258b-494c-422f-bf13-405bab335597":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"A shape overlay on a clip","properties":{"shapeOverlay":{"additionalProperties":false,"description":"A shape overlay on a clip: a square, circle, star… filled with any clip background.","properties":{"border":{"oneOf":[{"additionalProperties":false,"properties":{"color":{"description":"Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.","example":"#FFFFFFFF","pattern":"^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.border.oneOf.0.color","typeLabel":"string"},"width":{"description":"Artboard pixels, drawn inside the outline.","exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.border.oneOf.0.width","typeLabel":"number"}},"required":["color","width"],"type":"object","isRequired":true,"uniqueKey":"shapeOverlay.border.oneOf.0","typeLabel":"object"},{"additionalProperties":false,"properties":{"color":{"description":"Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.","example":"#FFFFFFFF","pattern":"^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$","type":"string"},"width":{"description":"Artboard pixels, drawn inside the outline.","exclusiveMinimum":true,"minimum":0,"type":"number"}},"required":["color","width"],"type":"null","isRequired":true,"uniqueKey":"shapeOverlay.border.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shapeOverlay.border","typeLabel":"object | null"},"cornerRadius":{"oneOf":[{"type":"number","description":"The corners' own radius in story pixels, or null for their preset's.","maximum":512,"minimum":0,"example":24,"isRequired":true,"uniqueKey":"shapeOverlay.cornerRadius.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"shapeOverlay.cornerRadius.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shapeOverlay.cornerRadius","typeLabel":"number | null"},"corners":{"type":"string","description":"How a square's corners are rounded.","enum":["none","regular","squircle"],"example":"squircle","isRequired":true,"uniqueKey":"shapeOverlay.corners","typeLabel":"enum\u003cstring>"},"depth":{"description":"Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. `front` paints over everything. `behind_presenter` paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on `front`. Without a presenter the overlay paints in front either way.","enum":["front","behind_presenter"],"example":"behind_presenter","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.depth","typeLabel":"enum\u003cstring>"},"dimensions":{"additionalProperties":false,"description":"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.","properties":{"height":{"example":540,"exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.dimensions.height","typeLabel":"number"},"width":{"example":960,"exclusiveMinimum":true,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.dimensions.width","typeLabel":"number"}},"required":["width","height"],"type":"object","isRequired":true,"uniqueKey":"shapeOverlay.dimensions","typeLabel":"object"},"durationMs":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.durationMs","typeLabel":"number"},"fill":{"type":"object","description":"What fills the shape, cut to its outline.","required":["type"],"properties":{"type":{"description":"Background variant. `ambient`: the clip's screen, else its camera, heavily blurred; no other fields. `shaderGradient`: an animated gradient set by `shaderGradientPreset`; echoing a non-preset one unchanged keeps it.","enum":["solid","gradient","image","video","shaderGradient","ambient"],"example":"solid","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.fill.type","typeLabel":"enum\u003cstring>"},"color":{"oneOf":[{"description":"Hex color string. Required when type = 'solid'.","example":"#000000ff","type":"string","uniqueKey":"shapeOverlay.fill.color.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'solid'.","example":"#000000ff","type":"null","uniqueKey":"shapeOverlay.fill.color.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.color","typeLabel":"string | null"},"gradientAngle":{"oneOf":[{"description":"Linear gradient angle in degrees. Required when type = 'gradient'.","example":45,"maximum":9007199254740991,"minimum":-9007199254740991,"type":"integer","uniqueKey":"shapeOverlay.fill.gradientAngle.oneOf.0","typeLabel":"integer"},{"description":"Linear gradient angle in degrees. Required when type = 'gradient'.","example":45,"maximum":9007199254740991,"minimum":-9007199254740991,"type":"null","uniqueKey":"shapeOverlay.fill.gradientAngle.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.gradientAngle","typeLabel":"integer | null"},"gradientColor1":{"oneOf":[{"description":"Hex color string. Required when type = 'gradient'.","example":"#ff0080ff","type":"string","uniqueKey":"shapeOverlay.fill.gradientColor1.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'gradient'.","example":"#ff0080ff","type":"null","uniqueKey":"shapeOverlay.fill.gradientColor1.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.gradientColor1","typeLabel":"string | null"},"gradientColor2":{"oneOf":[{"description":"Hex color string. Required when type = 'gradient'.","example":"#7928caff","type":"string","uniqueKey":"shapeOverlay.fill.gradientColor2.oneOf.0","typeLabel":"string"},{"description":"Hex color string. Required when type = 'gradient'.","example":"#7928caff","type":"null","uniqueKey":"shapeOverlay.fill.gradientColor2.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.gradientColor2","typeLabel":"string | null"},"imageUrl":{"oneOf":[{"description":"Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"string","uniqueKey":"shapeOverlay.fill.imageUrl.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"null","uniqueKey":"shapeOverlay.fill.imageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.imageUrl","typeLabel":"string\u003curi> | null"},"shaderGradientPreset":{"oneOf":[{"description":"Animated gradient preset from `GET /v1/backgrounds`. Required when type = 'shaderGradient'.","example":"Halo","type":"string","uniqueKey":"shapeOverlay.fill.shaderGradientPreset.oneOf.0","typeLabel":"string"},{"description":"Animated gradient preset from `GET /v1/backgrounds`. Required when type = 'shaderGradient'.","example":"Halo","type":"null","uniqueKey":"shapeOverlay.fill.shaderGradientPreset.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.shaderGradientPreset","typeLabel":"string | null"},"sourceId":{"oneOf":[{"description":"Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.","example":"su_abc123","type":"string","uniqueKey":"shapeOverlay.fill.sourceId.oneOf.0","typeLabel":"string"},{"description":"Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. A video background source must have its file uploaded, be 20 MB or smaller, and not be an audio or auto capture source; it is also saved to your uploaded video backgrounds, like an upload in the editor. Input-only.","example":"su_abc123","type":"null","uniqueKey":"shapeOverlay.fill.sourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.sourceId","typeLabel":"string | null"},"videoDurationSeconds":{"oneOf":[{"description":"Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.","example":12.4,"minimum":0,"type":"number","uniqueKey":"shapeOverlay.fill.videoDurationSeconds.oneOf.0","typeLabel":"number"},{"description":"Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.","example":12.4,"minimum":0,"type":"null","uniqueKey":"shapeOverlay.fill.videoDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.videoDurationSeconds","typeLabel":"number | null"},"videoUrl":{"oneOf":[{"description":"Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"string","uniqueKey":"shapeOverlay.fill.videoUrl.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.","format":"uri","type":"null","uniqueKey":"shapeOverlay.fill.videoUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"shapeOverlay.fill.videoUrl","typeLabel":"string\u003curi> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"shapeOverlay.fill","typeLabel":"object"},"id":{"description":"Shape overlay ID","example":"ly_abc123","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"shapeOverlay.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"shapeOverlay.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shapeOverlay.name","typeLabel":"string | null"},"path":{"oneOf":[{"description":"SVG path data in a 0–100 box, for shapeType `path`; null otherwise.","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.path.oneOf.0","typeLabel":"string"},{"description":"SVG path data in a 0–100 box, for shapeType `path`; null otherwise.","type":"null","isRequired":true,"uniqueKey":"shapeOverlay.path.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shapeOverlay.path","typeLabel":"string | null"},"point":{"additionalProperties":false,"description":"Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.","properties":{"xPct":{"example":30,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.point.xPct","typeLabel":"number"},"yPct":{"example":30,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.point.yPct","typeLabel":"number"}},"required":["xPct","yPct"],"type":"object","isRequired":true,"uniqueKey":"shapeOverlay.point","typeLabel":"object"},"shadow":{"description":"Drop shadow, matching the editor's Shadow menu. It falls from the background box when the text has one, else from the letters.","enum":["none","subtle","deep"],"example":"subtle","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.shadow","typeLabel":"enum\u003cstring>"},"shapeType":{"description":"The outline, stretched to fill the overlay box: a non-square box makes a rectangle or an oval. `path` draws the overlay's own `path`.","enum":["square","circle","triangle","diamond","star","hexagon","arrow","path"],"type":"string","isRequired":true,"uniqueKey":"shapeOverlay.shapeType","typeLabel":"enum\u003cstring>"},"startTimeMs":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.startTimeMs","typeLabel":"number"},"transition":{"description":"How one thing gives way to the next: `smooth` eases across the change, `hard_cut` swaps instantly.","enum":["smooth","hard_cut"],"example":"smooth","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.transition","typeLabel":"enum\u003cstring>"},"zIndex":{"description":"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.","example":0,"maximum":9007199254740991,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"shapeOverlay.zIndex","typeLabel":"integer"},"depthChanges":{"type":"array","items":{"additionalProperties":false,"properties":{"atMs":{"description":"Ms after the overlay starts.","example":1200,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"shapeOverlay.depthChanges.items.[INDEX].atMs","typeLabel":"number"},"depth":{"description":"Where the overlay sits relative to the presenter: the person in the clip's camera recording, or in its uploaded footage when the clip has no camera. `front` paints over everything. `behind_presenter` paints it behind the person but over everything else: in any layout the person is matted out of their footage and redrawn above the overlay. Fullscreen and framed layouts keep the recorded room around them; a cut-out layout replaces the room with the clip background. New overlays start on `front`. Without a presenter the overlay paints in front either way.","enum":["front","behind_presenter"],"example":"behind_presenter","type":"string","isRequired":true,"uniqueKey":"shapeOverlay.depthChanges.items.[INDEX].depth","typeLabel":"enum\u003cstring>"}},"required":["atMs","depth"],"type":"object","uniqueKey":"shapeOverlay.depthChanges.items.[INDEX]","typeLabel":"object"},"description":"Changes of `depth` over the overlay's own time, each held until the next: `atMs` after the overlay starts it moves to that depth, so one overlay can pass in front of the presenter and back behind them (a ring orbiting their head, a title they step in front of). `depth` is where it starts. On updates, omit it to leave the changes as they are; `[]` removes them. Absent in responses while the overlay holds one depth.","uniqueKey":"shapeOverlay.depthChanges","typeLabel":"object[]"}},"required":["id","name","shapeType","path","fill","corners","cornerRadius","border","shadow","startTimeMs","durationMs","point","dimensions","transition","depth","zIndex"],"type":"object","isRequired":true,"uniqueKey":"shapeOverlay","typeLabel":"object"}},"required":["shapeOverlay"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"shapeOverlay":{"border":{"color":"#FFFFFFFF","width":1},"cornerRadius":24,"corners":"squircle","depth":"behind_presenter","dimensions":{"height":540,"width":960},"durationMs":1,"fill":{"type":"solid","color":"#000000ff","gradientAngle":45,"gradientColor1":"#ff0080ff","gradientColor2":"#7928caff","imageUrl":"\u003cstring>","shaderGradientPreset":"Halo","sourceId":"su_abc123","videoDurationSeconds":12.4,"videoUrl":"\u003cstring>"},"id":"ly_abc123","name":"\u003cstring>","path":"\u003cstring>","point":{"xPct":30,"yPct":30},"shadow":"subtle","shapeType":"square","startTimeMs":1,"transition":"smooth","zIndex":0,"depthChanges":[{"atMs":1200,"depth":"behind_presenter"}]}}}},"exampleType":"generated"}},"description":"OK","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"generated"},"26ff4aea-8819-4b99-8498-5023d0c9b29f":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"bad_request","message":"The request was malformed or contained invalid parameters."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"bad_request","message":"The request was malformed or contained invalid parameters."}}},"exampleType":"examples"}},"description":"The request was malformed or contained invalid parameters.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"af6eb1a6-7789-4e93-9a8b-4a7f7a2b505e":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"unauthorized","message":"Authentication is required. Provide a valid API key."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"unauthorized","message":"Authentication is required. Provide a valid API key."}}},"exampleType":"examples"}},"description":"Authentication is required. Provide a valid API key.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"cc435654-487d-46a8-93d6-dcbff635b64f":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"forbidden","message":"You don't have permission to access this resource."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"forbidden","message":"You don't have permission to access this resource."}}},"exampleType":"examples"}},"description":"You don't have permission to access this resource.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"767cfe20-015d-4721-8d41-3f170fcfe832":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"not_found","message":"The requested resource was not found."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"not_found","message":"The requested resource was not found."}}},"exampleType":"examples"}},"description":"The requested resource was not found.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"23a6be44-2af5-48a1-99d9-f2f09ac1f360":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"conflict","message":"The request conflicts with the resource's current state, e.g. an Idempotency-Key whose first request is still in progress. Retry once it settles."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"conflict","message":"The request conflicts with the resource's current state, e.g. an Idempotency-Key whose first request is still in progress. Retry once it settles."}}},"exampleType":"examples"}},"description":"The request conflicts with the resource's current state, e.g. an Idempotency-Key whose first request is still in progress. Retry once it settles.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"c3d832c9-d440-446e-97d3-fa23b98d195a":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"rate_limited","message":"You have exceeded the rate limit. Please slow down."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"rate_limited","message":"You have exceeded the rate limit. Please slow down."}}},"exampleType":"examples"}},"description":"You have exceeded the rate limit. Please slow down.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying a rate-limited request","example":45,"schema":{"minimum":1,"type":"integer"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"ca48c1eb-f116-43a8-85a6-3c5c5da41994":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"server_error","message":"An unexpected error occurred"},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"server_error","message":"An unexpected error occurred"}}},"exampleType":"examples"}},"description":"An unexpected error occurred","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"53523528-625e-4a4f-b204-5cfc642f72af":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"not_implemented","message":"The requested operation is not implemented."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"not_implemented","message":"The requested operation is not implemented."}}},"exampleType":"examples"}},"description":"The requested operation is not implemented.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"},"e2a010ab-c424-46ba-9993-046a3d2dcb3f":{"content":{"application/json":{"example":{"docsUrl":"https://docs.tella.com/","error":"unavailable","message":"A dependency was unavailable and the request was not executed. Safe to resend unchanged after the Retry-After delay."},"schema":{"additionalProperties":false,"description":"Standard error response format","properties":{"docsUrl":{"description":"Link to Tella API documentation","example":"https://docs.tella.com/","format":"uri","type":"string","isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string\u003curi>"},"error":{"description":"Machine-readable error code","enum":["bad_request","unauthorized","forbidden","not_found","rate_limited","server_error","conflict","edit_conflict","not_implemented","unavailable"],"example":"not_found","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"description":"Human-readable error message","example":"Resource not found","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message","docsUrl"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"docsUrl":"https://docs.tella.com/","error":"unavailable","message":"A dependency was unavailable and the request was not executed. Safe to resend unchanged after the Retry-After delay."}}},"exampleType":"examples"}},"description":"A dependency was unavailable and the request was not executed. Safe to resend unchanged after the Retry-After delay.","headers":{"Deprecation":{"description":"Indicates that an API operation is deprecated, following RFC 9745","example":"@1767225600","schema":{"type":"string"}},"RateLimit":{"description":"Current quota with remaining requests (`r`) and seconds until reset (`t`)","example":"\"public-api\";r=95;t=42","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Named quota policy with the request limit (`q`) and window in seconds (`w`)","example":"\"public-api\";q=100;w=60","schema":{"type":"string"}},"Sunset":{"description":"Indicates when a deprecated API operation will become unavailable, following RFC 8594","example":"Tue, 30 Jun 2026 23:59:59 GMT","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the current window","example":100,"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests remaining in the current window","example":95,"schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix timestamp in milliseconds when the window resets","example":1704067200000,"schema":{"format":"int64","type":"integer"}}},"exampleType":"examples"}},"security":{"a5e7e177-9907-4c77-b513-83924c5db48f":{"BearerAuth":{"description":"API key obtained from your Tella account settings","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"d2aabac2-b2bc-4b47-a6f4-a26614a56f79":{"description":"Production","url":"https://api.tella.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"API key obtained from your Tella account settings","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key obtained from your Tella account settings","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"tella","siteName":"Tella","title":"Update a shape overlay - Tella","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{},"searchTabScopes":[{"tab":"Help Center"},{"tab":"Developers"},{"tab":"Changelog"}]},"originalFileLocation":"api-reference/clips/update-a-shape-overlay.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a shape overlay\u0026#x27;s outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tella\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a shape overlay - Tella\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a shape overlay\u0026#x27;s outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tella\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tella.mintlify.site/docs/_mintlify/api/og/v2?division=Clips\u0026amp;title=Update+a+shape+overlay\u0026amp;description=Update+a+shape+overlay%27s+outline%2C+fill%2C+corners%2C+border%2C+shadow%2C+timing%2C+position%2C+size%2C+animation%2C+depth+or+stacking+order.+Only+the+fields+you+send+are+change\u0026amp;theme=83fc5c73f5b3900df40eca67\u0026amp;signature=820f00a1cbf5dde46f5ffd119b337038d4fb56d57cb91b0322eb26317e10da92\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a shape overlay - Tella\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a shape overlay\u0026#x27;s outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tella.mintlify.site/docs/_mintlify/api/og/v2?division=Clips\u0026amp;title=Update+a+shape+overlay\u0026amp;description=Update+a+shape+overlay%27s+outline%2C+fill%2C+corners%2C+border%2C+shadow%2C+timing%2C+position%2C+size%2C+animation%2C+depth+or+stacking+order.+Only+the+fields+you+send+are+change\u0026amp;theme=83fc5c73f5b3900df40eca67\u0026amp;signature=820f00a1cbf5dde46f5ffd119b337038d4fb56d57cb91b0322eb26317e10da92\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/tella/dDRDWwVgURpbIwO7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tella\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8278FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/clips/update-a-shape-overlay.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.tella.com/#organization\",\"name\":\"Tella\",\"url\":\"https://www.tella.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tella/znRZoQ3e3rlGBTT2/logo-light.svg?fit=max\u0026auto=format\u0026n=znRZoQ3e3rlGBTT2\u0026q=85\u0026s=dd044b03efe593b53353a039bfb31fbf\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.tella.com/docs#website\",\"name\":\"Tella\",\"url\":\"https://www.tella.com/docs\",\"publisher\":{\"@id\":\"https://www.tella.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay#webpage\",\"url\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay\",\"name\":\"Update a shape overlay\",\"description\":\"Update a shape overlay's outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\",\"isPartOf\":{\"@id\":\"https://www.tella.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://www.tella.com/docs/api-reference/account/get-the-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clips\",\"item\":\"https://www.tella.com/docs/api-reference/clips/list-text-presets\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a shape overlay\",\"item\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay#apireference\",\"headline\":\"Update a shape overlay\",\"name\":\"Update a shape overlay\",\"description\":\"Update a shape overlay's outline, fill, corners, border, shadow, timing, position, size, animation, depth or stacking order. Only the fields you send are changed.\",\"url\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay\",\"mainEntityOfPage\":{\"@id\":\"https://www.tella.com/docs/api-reference/clips/update-a-shape-overlay#webpage\"},\"publisher\":{\"@id\":\"https://www.tella.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.tella.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tella\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Tella\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/clips/update-a-shape-overlay.md","siteName":"Tella","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"/changelog"},{"anchor":"Community","icon":"users","href":"https://community.tella.tv"},{"anchor":"System Status","icon":"signal","href":"https://status.tella.com"},{"anchor":"Contact Support","icon":"envelope","href":"mailto:support@tella.com"},{"anchor":"Debug","icon":"bug","href":"/help/support/debug-camera-and-microphone-issues"}]},"tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/introduction/welcome"}]},{"tab":"Developers","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Set up the Tella MCP server for your AI agent","sidebarTitle":"AI agent setup","href":"/ai-onboarding"},{"title":"Quickstart","href":"/quickstart"},{"title":"Authentication","href":"/authentication"},{"title":"Rate limiting","href":"/rate-limiting"},{"title":"API versioning and deprecation","href":"/versioning"}]},{"group":"Guides","pages":[{"title":"Webhooks","href":"/webhooks"},{"title":"Model Context Protocol (MCP)","href":"/mcp-server"},{"title":"Media library API","href":"/media-library-api"},{"title":"Embed API","href":"/embed-api"}]},{"group":"MCP Tools","pages":[{"group":"Managing videos","pages":[{"title":"Videos","href":"/mcp-tools/videos"},{"title":"Playlists","href":"/mcp-tools/playlists"},{"title":"Tags","href":"/mcp-tools/tags"},{"title":"Agent chats","href":"/mcp-tools/agent-chats"},{"title":"Community skills","href":"/mcp-tools/community-skills"},{"title":"Webhooks","href":"/mcp-tools/webhooks"},{"title":"Social publishing","href":"/mcp-tools/social-publishing"},{"title":"Analytics","href":"/mcp-tools/analytics"},{"title":"Account","href":"/mcp-tools/account"},{"title":"Billing","href":"/mcp-tools/billing"},{"title":"Support","href":"/mcp-tools/support"}]},{"group":"Editing videos","pages":[{"title":"Batch edits","href":"/mcp-tools/batch-edits"},{"title":"Sources","href":"/mcp-tools/sources"},{"title":"Library","href":"/mcp-tools/library"},{"title":"AI media generation","href":"/mcp-tools/ai-media-generation"},{"title":"Auto Capture","href":"/mcp-tools/auto-capture"},{"title":"Backgrounds","href":"/mcp-tools/backgrounds"},{"title":"Chapters","href":"/mcp-tools/chapters"},{"title":"Clips","href":"/mcp-tools/clips"},{"title":"Layouts","href":"/mcp-tools/layouts"},{"title":"Cropping","href":"/mcp-tools/cropping"},{"title":"Background Music","href":"/mcp-tools/background-music"},{"title":"Zooms","href":"/mcp-tools/zooms"},{"title":"Mouse events","href":"/mcp-tools/mouse-events"},{"title":"Key events","href":"/mcp-tools/key-events"},{"title":"Camera faces","href":"/mcp-tools/camera-faces"},{"title":"Blurs and highlights","href":"/mcp-tools/blurs-and-highlights"},{"title":"Overlays","href":"/mcp-tools/overlays"},{"title":"Text overlays","href":"/mcp-tools/text-overlays"},{"title":"Shape overlays","href":"/mcp-tools/shape-overlays"},{"title":"Sound effects","href":"/mcp-tools/sound-effects"}]},{"group":"Tella Motion","pages":[{"title":"Tella Motion","href":"/mcp-tools/motion"},{"title":"Tella Motion commands","href":"/mcp-tools/motion-commands"},{"title":"Tella Motion properties, easing and fonts","href":"/mcp-tools/motion-values"},{"title":"Tella Motion effects","href":"/mcp-tools/motion-effects"}]}]},{"group":"API Reference","pages":[{"group":"Account","pages":[{"title":"Get the account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account","href":"/api-reference/account/get-the-account"}]},{"group":"Agent chats","pages":[{"title":"List a video's agent chats","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/agent-chats","href":"/api-reference/agent-chats/list-a-videos-agent-chats"},{"title":"Start an agent chat","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/agent-chats","href":"/api-reference/agent-chats/start-an-agent-chat"}]},{"group":"Analytics","pages":[{"title":"Get workspace analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/analytics","href":"/api-reference/analytics/get-workspace-analytics"},{"title":"List workspace views","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/analytics/views","href":"/api-reference/analytics/list-workspace-views"},{"title":"List a playlist's views","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playlists/{id}/views","href":"/api-reference/analytics/list-a-playlists-views"},{"title":"Get video analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/analytics","href":"/api-reference/analytics/get-video-analytics"},{"title":"List a video's views","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/views","href":"/api-reference/analytics/list-a-videos-views"}]},{"group":"Auto Capture","pages":[{"title":"Report an Auto Capture take","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/auto-captures/{sourceId}/reports","href":"/api-reference/auto-capture/report-an-auto-capture-take"}]},{"group":"Backgrounds","pages":[{"title":"List available backgrounds","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/backgrounds","href":"/api-reference/backgrounds/list-available-backgrounds"}]},{"group":"Library","pages":[{"title":"List library items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/library","href":"/api-reference/library/list-library-items"},{"title":"Add a source to the library","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/library","href":"/api-reference/library/add-a-source-to-the-library"},{"title":"Split an image into layers","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/library/decompositions","href":"/api-reference/library/split-an-image-into-layers"},{"title":"Generate media with AI","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/library/generations","href":"/api-reference/library/generate-media-with-ai"},{"title":"Get a generation's status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/library/generations/{id}","href":"/api-reference/library/get-a-generations-status"},{"title":"Import media from a URL","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/library/imports","href":"/api-reference/library/import-media-from-a-url"},{"title":"Get an import's status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/library/imports/{id}","href":"/api-reference/library/get-an-imports-status"},{"title":"Capture a web page or social post","deprecated":true,"version":null,"openapi":"/openapi.json post /v1/library/screenshots","href":"/api-reference/library/capture-a-web-page-or-social-post"},{"title":"Remove a library item","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/library/{id}","href":"/api-reference/library/remove-a-library-item"}]},{"group":"Tella Motion","pages":[{"title":"Add a Tella Motion clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/motion/clips","href":"/api-reference/tella-motion/add-a-tella-motion-clip"},{"title":"List Tella Motion documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents","href":"/api-reference/tella-motion/list-tella-motion-documents"},{"title":"Create a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/motion/documents","href":"/api-reference/tella-motion/create-a-tella-motion-document"},{"title":"Summarize a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}","href":"/api-reference/tella-motion/summarize-a-tella-motion-document"},{"title":"Edit a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/motion/documents/{id}/commands","href":"/api-reference/tella-motion/edit-a-tella-motion-document"},{"title":"Inspect a composition","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/compositions/{compositionId}","href":"/api-reference/tella-motion/inspect-a-composition"},{"title":"Download a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/download","href":"/api-reference/tella-motion/download-a-tella-motion-document"},{"title":"Duplicate a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/motion/documents/{id}/duplicate","href":"/api-reference/tella-motion/duplicate-a-tella-motion-document"},{"title":"List a document's media","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/media","href":"/api-reference/tella-motion/list-a-documents-media"},{"title":"Inspect a node's properties","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/nodes","href":"/api-reference/tella-motion/inspect-a-nodes-properties"},{"title":"Get a node's stored fields","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/nodes/raw","href":"/api-reference/tella-motion/get-a-nodes-stored-fields"},{"title":"Get a frame or preview of a Tella Motion document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/documents/{id}/thumbnail","href":"/api-reference/tella-motion/get-a-frame-or-preview-of-a-tella-motion-document"},{"title":"List Tella Motion effects","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/effects","href":"/api-reference/tella-motion/list-tella-motion-effects"},{"title":"List Tella Motion fonts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/fonts","href":"/api-reference/tella-motion/list-tella-motion-fonts"},{"title":"Get a Tella Motion JSON schema","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/motion/schema","href":"/api-reference/tella-motion/get-a-tella-motion-json-schema"}]},{"group":"Playlist Groups","pages":[{"title":"List playlist groups","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playlist-groups","href":"/api-reference/playlist-groups/list-playlist-groups"},{"title":"Create a playlist group","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playlist-groups","href":"/api-reference/playlist-groups/create-a-playlist-group"},{"title":"Delete a playlist group","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/playlist-groups/{id}","href":"/api-reference/playlist-groups/delete-a-playlist-group"},{"title":"Rename or reorder a playlist group","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/playlist-groups/{id}","href":"/api-reference/playlist-groups/rename-or-reorder-a-playlist-group"}]},{"group":"Playlists","pages":[{"title":"List all playlists","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playlists","href":"/api-reference/playlists/list-all-playlists"},{"title":"Create a new playlist","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playlists","href":"/api-reference/playlists/create-a-new-playlist"},{"title":"Get playlist details","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/playlists/{id}","href":"/api-reference/playlists/get-playlist-details"},{"title":"Delete a playlist","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/playlists/{id}","href":"/api-reference/playlists/delete-a-playlist"},{"title":"Update a playlist","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/playlists/{id}","href":"/api-reference/playlists/update-a-playlist"},{"title":"Add a video to a playlist","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/playlists/{id}/videos","href":"/api-reference/playlists/add-a-video-to-a-playlist"},{"title":"Remove a video from a playlist","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/playlists/{id}/videos/{videoId}","href":"/api-reference/playlists/remove-a-video-from-a-playlist"}]},{"group":"Videos","pages":[{"title":"List connected social accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/social-accounts","href":"/api-reference/videos/list-connected-social-accounts"},{"title":"List subtitle presets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subtitle-presets","href":"/api-reference/videos/list-subtitle-presets"},{"title":"Save a subtitle preset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subtitle-presets","href":"/api-reference/videos/save-a-subtitle-preset"},{"title":"List all videos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos","href":"/api-reference/videos/list-all-videos"},{"title":"Create a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos","href":"/api-reference/videos/create-a-video"},{"title":"Search videos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/search","href":"/api-reference/videos/search-videos"},{"title":"Get video information","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}","href":"/api-reference/videos/get-video-information"},{"title":"Delete a video","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}","href":"/api-reference/videos/delete-a-video"},{"title":"Update a video","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}","href":"/api-reference/videos/update-a-video"},{"title":"Set background music","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/videos/{id}/background-music","href":"/api-reference/videos/set-background-music"},{"title":"Remove background music","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/background-music","href":"/api-reference/videos/remove-background-music"},{"title":"Get the beats of the background music","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/background-music/beats","href":"/api-reference/videos/get-the-beats-of-the-background-music"},{"title":"Download video captions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/captions","href":"/api-reference/videos/download-video-captions"},{"title":"Get video chapters","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/chapters","href":"/api-reference/videos/get-video-chapters"},{"title":"Replace video chapters","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/videos/{id}/chapters","href":"/api-reference/videos/replace-video-chapters"},{"title":"Add a collaborator to a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/collaborators","href":"/api-reference/videos/add-a-collaborator-to-a-video"},{"title":"Generate a document from a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/documents","href":"/api-reference/videos/generate-a-document-from-a-video"},{"title":"Get a generated document","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/documents/{documentId}","href":"/api-reference/videos/get-a-generated-document"},{"title":"Duplicate a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/duplicate","href":"/api-reference/videos/duplicate-a-video"},{"title":"Apply many video edits","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/edits","href":"/api-reference/videos/apply-many-video-edits"},{"title":"List video exports","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/exports","href":"/api-reference/videos/list-video-exports"},{"title":"Start a video export","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/exports","href":"/api-reference/videos/start-a-video-export"},{"title":"Get video export status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/exports/{exportId}","href":"/api-reference/videos/get-video-export-status"},{"title":"Get a live preview link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/live-preview","href":"/api-reference/videos/get-a-live-preview-link"},{"title":"List social publications","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/publish","href":"/api-reference/videos/list-social-publications"},{"title":"Publish a video to social media","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/publish","href":"/api-reference/videos/publish-a-video-to-social-media"},{"title":"Cancel a scheduled publish","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/publish","href":"/api-reference/videos/cancel-a-scheduled-publish"},{"title":"Get a recording link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/recording-link","href":"/api-reference/videos/get-a-recording-link"},{"title":"Get a video storyboard","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/storyboard","href":"/api-reference/videos/get-a-video-storyboard"},{"title":"Apply a subtitle preset","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/videos/{id}/subtitle-preset","href":"/api-reference/videos/apply-a-subtitle-preset"},{"title":"Get a video thumbnail or animated preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/thumbnail","href":"/api-reference/videos/get-a-video-thumbnail-or-animated-preview"},{"title":"Set a video's thumbnail","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/videos/{id}/thumbnail","href":"/api-reference/videos/set-a-videos-thumbnail"},{"title":"Remove a video's custom thumbnail","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/thumbnail","href":"/api-reference/videos/remove-a-videos-custom-thumbnail"},{"title":"Get a video's timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/timeline","href":"/api-reference/videos/get-a-videos-timeline"}]},{"group":"Sources","pages":[{"title":"Create a source upload (video, audio, image, or LUT)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/sources","href":"/api-reference/sources/create-a-source-upload-video-audio-image-or-lut"},{"title":"Get a source's processing status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}","href":"/api-reference/sources/get-a-sources-processing-status"},{"title":"Get the beats of an audio or video source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}/beats","href":"/api-reference/sources/get-the-beats-of-an-audio-or-video-source"},{"title":"Get a streaming upload storyboard","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}/storyboard","href":"/api-reference/sources/get-a-streaming-upload-storyboard"},{"title":"Get a thumbnail of a source on no clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}/thumbnail","href":"/api-reference/sources/get-a-thumbnail-of-a-source-on-no-clip"},{"title":"Get the transcript of a source on no clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}/transcript","href":"/api-reference/sources/get-the-transcript-of-a-source-on-no-clip"},{"title":"Get the audio waveform JSON for a source on no clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sources/{sourceId}/waveform","href":"/api-reference/sources/get-the-audio-waveform-json-for-a-source-on-no-clip"}]},{"group":"Tags","pages":[{"title":"List all tags","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tags","href":"/api-reference/tags/list-all-tags"},{"title":"Create a new tag","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tags","href":"/api-reference/tags/create-a-new-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"List a video's tags","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/tags","href":"/api-reference/tags/list-a-videos-tags"},{"title":"Add a tag to a video","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/tags","href":"/api-reference/tags/add-a-tag-to-a-video"},{"title":"Remove a tag from a video","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/tags/{tagId}","href":"/api-reference/tags/remove-a-tag-from-a-video"}]},{"group":"Clips","pages":[{"title":"List text presets","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/text-presets","href":"/api-reference/clips/list-text-presets"},{"title":"Save a text preset","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/text-presets","href":"/api-reference/clips/save-a-text-preset"},{"title":"Delete a text preset","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/text-presets/{presetId}","href":"/api-reference/clips/delete-a-text-preset"},{"title":"List clips for a video","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips","href":"/api-reference/clips/list-clips-for-a-video"},{"title":"Add a clip from an uploaded source","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips","href":"/api-reference/clips/add-a-clip-from-an-uploaded-source"},{"title":"Get a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}","href":"/api-reference/clips/get-a-clip"},{"title":"Delete a clip","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}","href":"/api-reference/clips/delete-a-clip"},{"title":"Update a clip","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}","href":"/api-reference/clips/update-a-clip"},{"title":"Get audio levels in a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/audio-levels","href":"/api-reference/clips/get-audio-levels-in-a-clip"},{"title":"Auto-crop a clip's screen recording","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/auto-crop","href":"/api-reference/clips/auto-crop-a-clips-screen-recording"},{"title":"List blurs on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/blurs","href":"/api-reference/clips/list-blurs-on-a-clip"},{"title":"Add a blur to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/blurs","href":"/api-reference/clips/add-a-blur-to-a-clip"},{"title":"Remove a blur","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/blurs/{maskId}","href":"/api-reference/clips/remove-a-blur"},{"title":"Update a blur","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/blurs/{maskId}","href":"/api-reference/clips/update-a-blur"},{"title":"List faces in a clip's camera","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/camera-faces","href":"/api-reference/clips/list-faces-in-a-clips-camera"},{"title":"Cut one or more time ranges from a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/cut","href":"/api-reference/clips/cut-one-or-more-time-ranges-from-a-clip"},{"title":"Cut clip ranges by transcript word indices","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/cut-by-transcript","href":"/api-reference/clips/cut-clip-ranges-by-transcript-word-indices"},{"title":"Duplicate a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/duplicate","href":"/api-reference/clips/duplicate-a-clip"},{"title":"Get clip color filters","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/filters","href":"/api-reference/clips/get-clip-color-filters"},{"title":"Set clip color filters","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/filters","href":"/api-reference/clips/set-clip-color-filters"},{"title":"List highlights on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/highlights","href":"/api-reference/clips/list-highlights-on-a-clip"},{"title":"Add a highlight to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/highlights","href":"/api-reference/clips/add-a-highlight-to-a-clip"},{"title":"Remove a highlight","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/highlights/{maskId}","href":"/api-reference/clips/remove-a-highlight"},{"title":"Update a highlight","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/highlights/{maskId}","href":"/api-reference/clips/update-a-highlight"},{"title":"List key presses on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/key-events","href":"/api-reference/clips/list-key-presses-on-a-clip"},{"title":"List layouts on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/layouts","href":"/api-reference/clips/list-layouts-on-a-clip"},{"title":"Add a layout to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/layouts","href":"/api-reference/clips/add-a-layout-to-a-clip"},{"title":"Remove a layout","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/layouts/{layoutId}","href":"/api-reference/clips/remove-a-layout"},{"title":"Update a layout","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/layouts/{layoutId}","href":"/api-reference/clips/update-a-layout"},{"title":"List mouse events on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/mouse-events","href":"/api-reference/clips/list-mouse-events-on-a-clip"},{"title":"List overlays on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/overlays","href":"/api-reference/clips/list-overlays-on-a-clip"},{"title":"Add an overlay to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/overlays","href":"/api-reference/clips/add-an-overlay-to-a-clip"},{"title":"Remove an overlay","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/overlays/{overlayId}","href":"/api-reference/clips/remove-an-overlay"},{"title":"Update an overlay","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/overlays/{overlayId}","href":"/api-reference/clips/update-an-overlay"},{"title":"Remove filler words from a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/remove-fillers","href":"/api-reference/clips/remove-filler-words-from-a-clip"},{"title":"Remove silences from a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/remove-silences","href":"/api-reference/clips/remove-silences-from-a-clip"},{"title":"Reorder a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/reorder","href":"/api-reference/clips/reorder-a-clip"},{"title":"List shape overlays on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/shape-overlays","href":"/api-reference/clips/list-shape-overlays-on-a-clip"},{"title":"Add a shape overlay to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/shape-overlays","href":"/api-reference/clips/add-a-shape-overlay-to-a-clip"},{"title":"Remove a shape overlay","description":"Removes a shape overlay from a clip.","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/shape-overlays/{shapeOverlayId}","href":"/api-reference/clips/remove-a-shape-overlay"},{"title":"Update a shape overlay","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/shape-overlays/{shapeOverlayId}","href":"/api-reference/clips/update-a-shape-overlay"},{"title":"Get silent ranges in a clip","description":"Returns silent ranges in a clip's audio, in ms on the clip's playback timeline (cuts applied) — pass ranges directly to the cut endpoint. Silences already removed by cuts are not reported.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/silences","href":"/api-reference/clips/get-silent-ranges-in-a-clip"},{"title":"List sound effects on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/sound-effects","href":"/api-reference/clips/list-sound-effects-on-a-clip"},{"title":"Add a sound effect to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/sound-effects","href":"/api-reference/clips/add-a-sound-effect-to-a-clip"},{"title":"Remove a sound effect","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/sound-effects/{soundEffectId}","href":"/api-reference/clips/remove-a-sound-effect"},{"title":"Update a sound effect","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/sound-effects/{soundEffectId}","href":"/api-reference/clips/update-a-sound-effect"},{"title":"List sources for a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/sources","href":"/api-reference/clips/list-sources-for-a-clip"},{"title":"Get a source thumbnail or animated preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/sources/{sourceId}/thumbnail","href":"/api-reference/clips/get-a-source-thumbnail-or-animated-preview"},{"title":"Get the audio waveform JSON for a source","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/sources/{sourceId}/waveform","href":"/api-reference/clips/get-the-audio-waveform-json-for-a-source"},{"title":"Split a clip in two","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/split","href":"/api-reference/clips/split-a-clip-in-two"},{"title":"Get a clip storyboard","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/storyboard","href":"/api-reference/clips/get-a-clip-storyboard"},{"title":"List text overlays on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/text-overlays","href":"/api-reference/clips/list-text-overlays-on-a-clip"},{"title":"Add a text overlay to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/text-overlays","href":"/api-reference/clips/add-a-text-overlay-to-a-clip"},{"title":"Remove a text overlay","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/text-overlays/{textOverlayId}","href":"/api-reference/clips/remove-a-text-overlay"},{"title":"Update a text overlay","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/text-overlays/{textOverlayId}","href":"/api-reference/clips/update-a-text-overlay"},{"title":"Get a clip thumbnail or animated preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/thumbnail","href":"/api-reference/clips/get-a-clip-thumbnail-or-animated-preview"},{"title":"Get clip transcript","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/transcript","href":"/api-reference/clips/get-clip-transcript"},{"title":"Correct transcript words","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/transcript/words","href":"/api-reference/clips/correct-transcript-words"},{"title":"List zooms on a clip","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/videos/{id}/clips/{clipId}/zooms","href":"/api-reference/clips/list-zooms-on-a-clip"},{"title":"Add a zoom to a clip","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/zooms","href":"/api-reference/clips/add-a-zoom-to-a-clip"},{"title":"Auto-generate zooms from mouse activity","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/videos/{id}/clips/{clipId}/zooms/auto","href":"/api-reference/clips/auto-generate-zooms-from-mouse-activity"},{"title":"Remove a zoom","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/videos/{id}/clips/{clipId}/zooms/{zoomId}","href":"/api-reference/clips/remove-a-zoom"},{"title":"Update a zoom","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/videos/{id}/clips/{clipId}/zooms/{zoomId}","href":"/api-reference/clips/update-a-zoom"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/webhooks/endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/webhooks/endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/webhooks/endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Get endpoint signing secret","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/endpoints/{id}/secret","href":"/api-reference/webhooks/get-endpoint-signing-secret"},{"title":"List recent webhook messages","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/messages","href":"/api-reference/webhooks/list-recent-webhook-messages"},{"title":"Get a specific webhook message","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/webhooks/messages/{id}","href":"/api-reference/webhooks/get-a-specific-webhook-message"}]}]},{"group":"Webhooks","pages":[{"group":"Videos","pages":[{"title":"Document generated","version":null,"deprecated":null,"openapi":"/webhooks.json webhook document.generated","href":"/api-reference/videos/document-generated"},{"title":"Export ready","version":null,"deprecated":null,"openapi":"/webhooks.json webhook export.ready","href":"/api-reference/videos/export-ready"},{"title":"Transcript ready","version":null,"deprecated":null,"openapi":"/webhooks.json webhook transcript.ready","href":"/api-reference/videos/transcript-ready"},{"title":"Video created","version":null,"deprecated":null,"openapi":"/webhooks.json webhook video.created","href":"/api-reference/videos/video-created"},{"title":"View milestone reached","version":null,"deprecated":null,"openapi":"/webhooks.json webhook video.milestone","href":"/api-reference/videos/view-milestone-reached"},{"title":"Video viewed","version":null,"deprecated":null,"openapi":"/webhooks.json webhook video.viewed","href":"/api-reference/videos/video-viewed"}]},{"group":"Playlists","pages":[{"title":"Playlist created","version":null,"deprecated":null,"openapi":"/webhooks.json webhook playlist.created","href":"/api-reference/playlists/playlist-created"},{"title":"Video added to playlist","version":null,"deprecated":null,"openapi":"/webhooks.json webhook playlist.video_added","href":"/api-reference/playlists/video-added-to-playlist"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update a shape overlay - Tella","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}