create_watch_room
Create a watch-together 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.
Parameterstitlevideo_urlstart_time
get_watch_party
Look up a 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.
Parametersroom_coderequired
update_watch_party
Change a watch party
Changes the start time and/or title of a watch party (a room made with create_watch_room, same room_code). The link stays the same, so invitations already sent keep working — prefer this over cancelling and creating a new one. Needs the organiser_key (or organiser_link) from create_watch_room. Guests who already added the old time to their calendar should be told to update it.
Parameterstitleroom_codestart_timeorganiser_keyorganiser_link
cancel_watch_party
Cancel a scheduled watch party
Cancels a watch party (a room made with create_watch_room, same room_code): its countdown page and link stop working. Needs the organiser_key (or organiser_link) that create_watch_room returned, so only the organiser can cancel. A room that is already open carries on until everyone leaves. Cannot be undone; confirm with the user first.
Parametersroom_codeorganiser_keyorganiser_link
create_branded_link
Create a branded watch-together link
Creates a permanent public page (…/r/<slug>) 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.
Parametersnamerequiredslugcolortaglinevideo_url
get_branded_link
Look up a 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.
Parametersslugrequired
update_branded_link
Change a 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.
Parametersnameslugcolortaglineedit_keyedit_linkvideo_url
delete_branded_link
Delete a branded link
Permanently deletes a branded page made with create_branded_link; its public link and posters stop working. Needs the private edit_link (or slug and edit_key). Cannot be undone; confirm with the user first.
Parametersslugedit_keyedit_link