show_overlay
Display a specified overlay in OBS Studio by providing its overlay ID, enabling quick visual transitions and scene enhancements through the showrunner API.
Instructions
Show an overlay.
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": {
"overlayId": "<overlayId>"
},
"name": "show_overlay"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | No | ||
| overlayId | Yes |