Skip to content

Interactive sites

A designed site, at a prefix of your choosing under interactive.vidmoat.com, that shows an account's own interactive videos, built from typed blocks over the API or MCP.

What it is#

A site is typed data: a theme of tokens, a header, up to 6 pages, and sections from a closed set. There is no HTML, CSS, script, style or embed anywhere: a site lives on a vidmoat.com address, so nothing a person or an agent writes ever runs there. A value outside a list is refused with the list; text over a limit is refused with the limit, never cut.

A site shows only the account's own interactive videos whose choices are published and shared (see Publishing in the Interactive video guide). Each plays with its own design.

Build it#

  1. Make a site with a prefix and a title: a draft at your prefix under interactive.vidmoat.com.
  2. Get the site with videos=true: it lists the videos it may show, with ids.
  3. Edit a site with ops: all applied or none.
  4. Open previewUrl (the draft on its real address, for an hour), then publish.

Theme#

  • tone: "dark", "light"
  • palette: "warm", "neutral", "cool", "forest", "plum"
  • font: "system", "serif", "mono", "rounded"
  • headingFont: "system", "serif", "mono", "rounded"
  • corners: "soft", "round", "square"
  • density: "comfortable", "compact", "airy"
  • width: "normal", "narrow", "wide"
  • playerAccent: "video", "site"
  • accent: "#RRGGBB", refused when words on it read under 4.5:1 or it shows under 3:1 against the page.

Sections#

  • hero: A big opening: a heading, a line or two, an optional featured interactive video and an optional button. Fields: heading, body (optional), video (optional), cta (optional), align (optional).
  • player: One interactive video, played with its own design. Fields: video, heading (optional), caption (optional), size (optional).
  • grid: A collection of interactive videos; each plays in place when tapped. Fields: videos, heading (optional), columns (optional).
  • story: How one interactive video branches. By default only its opening and first choice, with the endings counted, so a game is not spoiled; reveal "full" shows every scene, choice and ending. Fields: video, heading (optional), reveal (optional).
  • text: Rich text in a restricted Markdown: ## and ### headings, lists, bold, italic and https links. No HTML. Fields: markdown, heading (optional).
  • about: Who made this: a heading, a few lines and a picture from your library. Fields: heading, body, image (optional).
  • cta: A heading and one button to a page of this site or an https address. Fields: heading, button, body (optional).
  • links: A list of https links (your channels, a shop, a newsletter). Fields: links, heading (optional).

A button has a label and either a page (a slug, "" is home) or an https href. Text sections take a small Markdown: ## and ### headings, lists, bold, italic and https links.

Ops#

"setTheme", "setHeader", "setNav", "setFooter", "setSettings", "addPage", "updatePage", "removePage", "movePage", "addSection", "updateSection", "removeSection", "moveSection". addSection returns the new sectionId; updateSection with sectionId and set changes only the fields sent (null removes an optional one). Send rev to refuse a write over a newer draft.

PATCH body
{
  "ops": [
    { "op": "setTheme", "tone": "dark", "palette": "cool", "accent": "#4CC9F0", "headingFont": "serif" },
    { "op": "setHeader", "tagline": "Short films you play" },
    { "op": "addPage", "slug": "films", "title": "Films" },
    { "op": "setNav", "links": [{ "label": "Home", "page": "" }, { "label": "Films", "page": "films" }] },
    { "op": "addSection", "page": "", "section": { "kind": "grid", "heading": "Play them all",
      "videos": ["clx9abc123", "clx9def456"] } },
    { "op": "addSection", "page": "films", "section": { "kind": "story", "video": "clx9abc123" } }
  ]
}

Over MCP#

get_interactive_site (with videos: true, images: true, or prefix to check a name), edit_interactive_site (create, ops or prefix) and publish_interactive_site. The same ops and the same refusals as the API.

What a visitor gets#

A live site of an owner whose plan includes sites. Unpublished, taken offline, or an owner whose plan or account no longer allows it: a plain 404, and the site is kept. A published site can be found in search: each page carries its title, description, canonical link and video structured data, and /sitemap.xml lists every page. setSettings with indexing: false keeps a site out (noindex, no sitemap); a preview is never indexed.