Create a branded watch-together link
create_branded_linkCreates a permanent public page (…/r/) with a name, an optional one-line description, colour and video. Everyone who opens it lands in that page's room, any time, so it suits teachers, classes, clubs and communities who reuse one link every week (for a one-off, use create_watch_room). Returns public_link to share and a private edit_link: the user opens it to add a logo and background and download a poster with a QR code, and it is needed for update_branded_link and delete_branded_link. Give edit_link only to the user, never to guests.
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": {
"name": "<name>"
},
"name": "create_branded_link"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name shown on the page, e.g. "Ms. Lee's English Class". | |
| slug | No | Optional. The link ending: 3-30 lowercase Latin letters, digits and hyphens (e.g. lee-english). Made from the name if omitted. | |
| color | No | Optional theme colour as #rrggbb. | |
| tagline | No | Optional one line, e.g. "Every Tuesday at 8 pm". | |
| video_url | No | Optional video to load in the room. A direct video link (mp4, webm, m3u8) or a public YouTube video URL. Paid streaming services are not supported. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | false when the call failed; then code says why. | |
| code | No | Error code when ok is false. | |
| slug | No | The link ending. | |
| edit_link | No | Private edit link. | |
| public_link | No | Link to share. |