Documentation / Advanced reference

Story manifest format

Available now

Strict path-story 1.0.0, 1.1.0 and 1.2.0 schemas add features without changing earlier formats.

On this page

Example

{
  "format": "path-story", "version": "1.0.0",
  "id": "demo", "title": "A Sample Route", "entry": "start",
  "navigation": { "map": "enabled", "reveal": "adjacent" },
  "media": { "clip": { "playbackId": "PUBLIC_MUX_PLAYBACK_ID" } },
  "variables": { "foundKey": { "type": "boolean", "initial": false } },
  "nodes": {
    "start": { "type": "start", "to": "opening" },
    "opening": { "type": "video", "title": "Opening",
      "media": "clip", "in": 0, "out": 42, "next": "choice" },
    "choice": { "type": "decision", "prompt": "Which way?", "options": [
      { "id": "left", "label": "Take the left path", "to": "leftEnd" },
      { "id": "right", "label": "Take the right path", "to": "rightEnd",
        "when": { "variable": "foundKey", "equals": true },
        "unavailable": "locked" }
    ] },
    "leftEnd": { "type": "ending", "title": "The left route" },
    "rightEnd": { "type": "ending", "title": "The right route" }
  }
}

IDs

IDs are stable keys, independent of titles. Option IDs must be unique within a decision.

Version 1.1 decision playback

Version 1.1.0 adds canonical decision.playback: while is hold or loop; a loop names a media entry and an in/out range. Optional countdown specifies seconds (at least 3) and a wait, choose or go timeout outcome. Version 1.2.0 retains that playback and adds numeric add effects, compare conditions and Router nodes with ordered rules and required fallback. Version 1.0.0 remains valid and rejects newer fields; 1.1.0 rejects v1.2-only fields. The example’s playback ID and duration are placeholders, not proof of playable media. Validate with the versioned schemas and semantic graph rules before export.

Decision playback · Automatic Routers · Build with AI.

Back to all documentation