update_overlay_item
Update an existing overlay item. Can change text, position, timing, animation, opacity, and more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exit | No | Exit animation, or null to remove | |
| size | No | Normalized overlay size | |
| text | No | New text content | |
| type | No | Change item type when also supplying compatible fields | |
| color | No | New text color (hex or rgba) | |
| enter | No | Entrance animation, or null to remove | |
| width | No | Legacy shorthand for size.width | |
| border | No | Border styling, or null to remove | |
| editId | Yes | The edit ID | |
| height | No | Legacy shorthand for size.height | |
| itemId | Yes | The overlay item ID | |
| shadow | No | Media overlay drop shadow, or null to remove | |
| volume | No | Video overlay audio volume | |
| clipEnd | No | Video overlay trim end in seconds, or null to clear | |
| mediaId | No | MediaDocV2 ID for image/video overlays, or null to remove | |
| opacity | No | Opacity from 0 to 1 | |
| trackId | Yes | The overlay track ID | |
| duration | No | Timeline duration in seconds | |
| fontSize | No | New font size | |
| position | No | Normalized overlay position | |
| rotation | No | Rotation in degrees | |
| clipStart | No | Video overlay trim start in seconds | |
| fontStyle | No | New font style | |
| keyframes | No | Transform keyframes relative to item start | |
| positionX | No | Legacy shorthand for position.x | |
| positionY | No | Legacy shorthand for position.y | |
| speedRamp | No | Variable speed curve for video overlays, or null to clear | |
| startTime | No | Timeline start time in seconds | |
| textAlign | No | New text alignment | |
| fontFamily | No | New font family | |
| fontWeight | No | New font weight | |
| lineHeight | No | New line-height multiplier | |
| lineStyles | No | Per-line text style overrides | |
| textConfig | No | Full TextEffectConfig partial update | |
| strokeColor | No | New text stroke color | |
| strokeWidth | No | New text stroke width | |
| workspaceId | Yes | The workspace ID | |
| borderRadius | No | Corner radius in 720p logical pixels | |
| letterSpacing | No | New letter spacing | |
| playbackSpeed | No | Flat playback speed for video overlays | |
| textAnimation | No | New text animation | |
| remotionConfig | No | Update animation code or editable settings, merged with the existing composition | |
| textShadowBlur | No | New text shadow blur | |
| backgroundColor | No | New text background color | |
| textShadowColor | No | New text shadow color | |
| textShadowOffsetX | No | New text shadow horizontal offset | |
| textShadowOffsetY | No | New text shadow vertical offset | |
| backgroundPaddingX | No | New text background horizontal padding | |
| backgroundPaddingY | No | New text background vertical padding | |
| backgroundBorderRadius | No | New text background corner radius |