add_media_overlay
Add an image or video media overlay to the edit timeline with precise transform, border radius, border, shadow, clipping, speed ramp, volume, animations, and keyframes.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspaceId": "<workspaceId>",
"editId": "<editId>",
"mediaId": "<mediaId>",
"type": "<type>"
},
"name": "add_media_overlay"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exit | No | Exit animation, or null to remove | |
| size | No | Normalized overlay size | |
| type | Yes | Overlay media type | |
| 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 | |
| shadow | No | Media overlay drop shadow, or null to remove | |
| volume | No | Video overlay audio volume | |
| clipEnd | No | Video overlay source trim end in seconds | |
| mediaId | Yes | Workspace MediaDocV2 ID to use as the overlay source | |
| opacity | No | Opacity from 0 to 1 | |
| trackId | No | Overlay track ID (auto-creates a track if not provided) | |
| duration | No | Timeline duration in seconds | |
| position | No | Normalized overlay position | |
| rotation | No | Rotation in degrees | |
| clipStart | No | Video overlay source trim start in seconds | |
| 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 | |
| startTime | No | Timeline start time in seconds | |
| workspaceId | Yes | The workspace ID | |
| borderRadius | No | Corner radius in 720p logical pixels | |
| playbackSpeed | No | Flat playback speed for video overlays |