add_text_overlay
Adds a text layer over a video timeline using a MOGRT template, filling up to four text fields such as a main title and subtitle. Use it to place timed titles on a chosen track and sequence.
Instructions
Adds a text layer (title) over the video timeline. Requires a MOGRT (.mogrt) template file path. Supports up to 4 text fields (text, text2, text3, text4) — each populates the Nth "AE.ADBE Text" component in the MOGRT (e.g., for Basic Lower Third: text=main title, text2=subtitle).
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": {
"text": "<text>",
"sequenceId": "<sequenceId>",
"trackIndex": "<trackIndex>",
"startTime": "<startTime>",
"duration": "<duration>"
},
"name": "add_text_overlay"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Text for the first AE text component in the MOGRT (typically the main title) | |
| text2 | No | Text for the second AE text component (e.g., subtitle of a lower third) | |
| text3 | No | Text for the third AE text component (if present) | |
| text4 | No | Text for the fourth AE text component (if present) | |
| duration | Yes | How long the text should remain on screen in seconds (best-effort; the MOGRT's natural duration may take precedence) | |
| mogrtPath | No | Absolute path to a .mogrt template file (required for text overlays) | |
| startTime | Yes | The time in seconds when the text should appear | |
| sequenceId | Yes | The sequence to add the text to | |
| trackIndex | Yes | The video track to place the text on (0-indexed; create the track first via add_track if needed) | |
| textPropertyName | No | Override: explicit displayName of the property to write into. When set, only `text` is written (text2/text3/text4 are ignored) and the call fails if no property with that displayName exists. Use only when auto-detection picks the wrong field. | |
| rollbackOnTextFailure | No | If true, remove the imported timeline Graphic when every requested text write fails. Defaults to false; the imported project item may remain in the Project panel. |