Loading server...
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 40,
"description": "Name shown on the page, e.g. \"Ms. Lee's English Class\"."
},
"slug": {
"type": "string",
"maxLength": 30,
"description": "Optional. The link ending: 3-30 lowercase Latin letters, digits and hyphens (e.g. lee-english). Made from the name if omitted."
},
"tagline": {
"type": "string",
"maxLength": 120,
"description": "Optional one line, e.g. \"Every Tuesday at 8 pm\"."
},
"color": {
"type": "string",
"description": "Optional theme colour as #rrggbb."
},
"video_url": {
"type": "string",
"description": "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."
}
},
"required": [
"name"
],
"additionalProperties": false
}
Create a watch-together room
create_watch_room
Creates a private ScreenParty room where friends watch the same video in sync, in their browsers, with chat and voice. Use it when the user wants to watch something together now, or plan a watch party at a set time. Without start_time the room is ready now: the first person to open room_link becomes the host (controls playback), so tell the user to open it before sharing. With start_time it returns a countdown page with "add to calendar" for guests; the room opens 15 minutes early, and organiser_link lets the user open it any time and host it. Share room_link or schedule_page with guests; keep organiser_link and organiser_key for the user only (they also change it with update_watch_party and cancel it with cancel_watch_party). The room made here is what the *_watch_party tools call a watch party — same room_code.
Schema valid · SHA-256 f67a7e6e5570…
View input schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 60,
"description": "What people will watch, e.g. \"Lesson 3: Past tense\". Defaults to \"Watch party\"."
},
"video_url": {
"type": "string",
"description": "Optional video the room opens with. A direct video link (mp4, webm, m3u8) or a public YouTube video URL. Paid streaming services are not supported."
},
"start_time": {
"type": "string",
"description": "Optional. ISO 8601 date-time WITH a time zone, e.g. 2026-11-07T20:00:00+08:00 (ask the user for their time zone if unknown). Omit for a room that opens now. Up to 60 days ahead."
}
},
"additionalProperties": false
}
Look up a branded link
get_branded_link
Shows what a branded page (…/r/<slug>) currently says: name, description, colour, video, whether it has a logo or background, and whether people are in its room right now. Use it before changing a page or to check a slug the user mentions. Read-only; needs no key.
Schema valid · SHA-256 328dd5a028af…
View input schema
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"maxLength": 60,
"description": "The slug after /r/, or the whole public link."
}
},
"required": [
"slug"
],
"additionalProperties": false
}
Look up a watch party
get_watch_party
Looks up a watch party — a room made with create_watch_room, now or scheduled — by its 5-character code (from create_watch_room or from a ScreenParty link such as …/s/AB2CD or …room.html?room=AB2CD). Returns its title, start time, whether guests can enter yet and whether people are in it right now. Use it to answer "when does it start?" or "is it open?". Read-only; it never reveals who is in the room.
Schema valid · SHA-256 f097cffe1165…
View input schema
{
"type": "object",
"properties": {
"room_code": {
"type": "string",
"maxLength": 10,
"description": "The 5-character room code, e.g. AB2CD."
}
},
"required": [
"room_code"
],
"additionalProperties": false
}
Change a branded link
update_branded_link
Changes the name, description, colour or video of a branded page made with create_branded_link. Pass only the fields to change; the link itself (slug) stays the same, so posters and shared links keep working. Needs the private edit_link (or slug and edit_key). Pass video_url as an empty string to remove the video. Logo and background are changed on the edit page, not here.
Schema valid · SHA-256 4a12d6d5d16b…
View input schema
{
"type": "object",
"properties": {
"edit_link": {
"type": "string",
"description": "The private edit link returned by create_branded_link (…/r/<slug>/edit#k=<key>). Alternatively pass slug and edit_key."
},
"slug": {
"type": "string",
"maxLength": 60,
"description": "The page's slug (the part after /r/). Needed with edit_key when edit_link is not given."
},
"edit_key": {
"type": "string",
"maxLength": 99,
"description": "The key after #k= in the edit link."
},
"name": {
"type": "string",
"maxLength": 40,
"description": "New name."
},
"tagline": {
"type": "string",
"maxLength": 120,
"description": "New one-line description; empty string removes it."
},
"color": {
"type": "string",
"description": "New theme colour as #rrggbb."
},
"video_url": {
"type": "string",
"description": "New video, or empty string for none. A direct video link (mp4, webm, m3u8) or a public YouTube video URL. Paid streaming services are not supported."
}
},
"additionalProperties": false
}