Add or replace an overlay
put_overlayText, a picture or a clip for chosen seconds; overlay_id replaces one. Cost: Free.
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": {
"kind": "<kind>",
"start": "<start>",
"end": "<end>",
"x": "<x>",
"y": "<y>",
"width": "<width>",
"height": "<height>"
},
"name": "put_overlay"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | Centre across. | |
| y | Yes | Centre down. | |
| end | Yes | Film second it goes. | |
| font | No | kind text: the face; Inter-Medium when left out. | |
| kind | Yes | text, image or video. | |
| more | No | More overlays in the same save, each with the fields above. | |
| text | No | kind text: the words. | |
| align | No | kind text: alignment in the box. | |
| color | No | A colour, #RRGGBB. | |
| start | Yes | Film second it appears. | |
| width | Yes | Box width. | |
| behind | No | Behind the speaker. | |
| height | Yes | Box height. | |
| hidden | No | Kept, not shown. | |
| asset_id | No | image or video: an asset_id from import_media or list_assets. | |
| rotation | No | Degrees. | |
| video_id | No | Video; the open one if left out. | |
| animation | No | How it arrives and leaves; none (a cut) when left out. | |
| font_size | No | text: letter height, a fraction of the frame; 0.05 if left out. | |
| output_id | No | Output id. | |
| source_in | No | kind video: the clip second it starts from. | |
| until_end | No | Stays to the end. | |
| overlay_id | No | The ov_ id to replace; left out, the same look is the same one. | |
| base_version | No | Version id you read. | |
| operation_id | No | Same id retries run once. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| cost | No | ||
| error | No | ||
| state | No | ||
| status | No | ||
| dry_run | No | ||
| message | No | ||
| plan_id | No | ||
| style_id | No | ||
| video_id | No | ||
| available | No | ||
| import_id | No | ||
| output_id | No | ||
| studio_url | No | ||
| version_id | No |