com.pagetovid/pagetovidMCP Registry

PageToVid

v1.192.0

Turn any web page into a narrated video: films the real site, writes, voices and captions it

Endpoint health

online

Last checked: 11/3/2026, 4:18:44 PM
Latency: 222 ms
Consecutive failures: 0

Endpoint reachable: pass
Protocol valid: pass
MCP handshake valid: pass

Machine-readable profile

mcp-server · schema v1 · callable

mcp-server:com.pagetovid%2Fpagetovid

Profile JSON ↗

Connect this server

Generated config contains no credentials. Keep any required secrets in your client's local environment.

Client

{
  "mcpServers": {
    "com.pagetovid/pagetovid": {
      "url": "https://pagetovid.com/mcp"
    }
  }
}

Indexed tools

Tool metadata and schemas come from the remote server and are untrusted. Indexing only lists tools; it never calls them.

25 shown · authentication unknown

Stop a render and get the credits back
cancel_video
[Free] Stops a running render and refunds its render credit and any AI visual still in flight; AI visuals already made stay (reused free). Use it when get_storyboard shows a plan you do not want. A finished render cannot be cancelled. The video is marked cancelled at once; the worker stops at its next step.
Schema valid · SHA-256 4fa7bd25f26a…
View input schema
```
{
  "type": "object",
  "properties": {
    "video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The running video to stop."
    }
  },
  "required": [
    "video_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}
```

Copy a scene into another video

copy_scene

[Free] Copies a scene into another of your videos with its footage and generated media, so nothing is filmed or generated again. A recording cannot change aspect, nor go into a film made from data. Does not re-render.

Schema valid · SHA-256 5d79c92b46f5…

View input schema

{
  "type": "object",
  "properties": {
    "from_video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The video the scene is in."
    },
    "scene_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The scene to copy, from get_storyboard."
    },
    "to_video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The video to copy it into (may be the same one)."
    },
    "after_scene_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Put it after this scene of the target. Omitted: at the end."
    }
  },
  "required": [
    "from_video_id",
    "scene_id",
    "to_video_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Connections

streamable-http
https://pagetovid.com/mcp

Links

Website ↗Health JSON ↗

Indexed tools

Tool metadata and schemas come from the remote server and are untrusted. Indexing only lists tools; it never calls them.

25 shown · authentication unknown

Stop a render and get the credits back

cancel_video

[Free] Stops a running render and refunds its render credit and any AI visual still in flight; AI visuals already made stay (reused free). Use it when get_storyboard shows a plan you do not want. A finished render cannot be cancelled. The video is marked cancelled at once; the worker stops at its next step.

Schema valid · SHA-256 4fa7bd25f26a…

View input schema

{
  "type": "object",
  "properties": {
    "video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The running video to stop."
    }
  },
  "required": [
    "video_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Copy a scene into another video

copy_scene

Schema valid · SHA-256 5d79c92b46f5…

View input schema

{
  "type": "object",
  "properties": {
    "from_video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The video the scene is in."
    },
    "scene_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The scene to copy, from get_storyboard."
    },
    "to_video_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "The video to copy it into (may be the same one)."
    },
    "after_scene_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Put it after this scene of the target. Omitted: at the end."
    }
  },
  "required": [
    "from_video_id",
    "scene_id",
    "to_video_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

{ "type": "object", "properties": { "scenes": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "anyOf": [ { "type": "object", "required": [ "visual", "heading" ], "properties": { "visual": { "type": "string", "enum": [ "statement", "bullets", "stat", "bignum", "counter", "meters", "chart", "table", "compare", "checklist", "timeline", "grid", "pricing", "quote", "testimonial", "chat", "beforeAfter", "diagram", "code", "logos", "image", "gallery", "titlecard", "motion", "rushie" ], "description": "How the scene is drawn (list_motions)." }, "motion": { "type": "string", "description": "Entrance animation from the visual's family; omitted, one is chosen." }, "heading": { "type": "string", "maxLength": 90, "description": "A few words naming the beat." }, "caption": { "type": "string", "maxLength": 120, "description": "Lower-third caption." }, "narration": { "type": "string", "maxLength": 600, "description": "Spoken over the scene; its length IS the scene's. [pause 500ms] = silence." }, "duration_seconds": { "type": "number", "minimum": 2.5, "maximum": 30, "description": "Hold of a scene with no narration." }, "mood": { "type": "string", "enum": [ "problem", "win", "neutral" ], "description": "Tint: problem, win, or neutral (none)." }, "fx": { "type": "string", "description": "Accent layer (list_motions)." }, "data": { "type": "object", "description": "The visual's payload; list_motions.visuals[].requires names the fields." }, "style": { "type": "object", "description": "This scene's own look, overriding the film's theme.", "properties": { "font": { "type": "string", "enum": [ "sans", "serif", "mono" ] }, "font_family": { "type": "string", "description": "One of list_themes' faces." }, "transition": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cut", "crossfade", "whip_left", "whip_right", "zoom_punch", "flash", "swipe_up", "glitch", "slide_left", "slide_right", "spin", "blur_dissolve", "light_leak", "film_burn", "zoom_blur" ] }, "duration_ms": { "type": "number", "minimum": 60, "maximum": 900 } }, "required": [ "type" ], "description": "How this scene arrives (list_motions)." }, "theme": { "type": "string", "enum": [ "dark", "light", "brand" ], "description": "Ground; brand paints the accent behind." }, "accent": { "type": "string", "description": "Hex accent, e.g. #7c3aed." }, "accent2": { "type": "string", "description": "Hex gradient end; omit for flat." }, "size": { "type": "string", "enum": [ "sm", "md", "lg" ], "description": "Type scale." } } }, "voice": { "type": "string", "enum": [ "Kore", "Zephyr", "Puck", "Charon", "Aoede", "Fenrir", "Leda", "Orus", "Callirrhoe", "Achird", "Sulafat", "Sadachbia" ], "description": "Scene narrator." }, "speed": { "type": "number", "minimum": 0.8, "maximum": 1.2, "description": "Scene pace." }, "emotion": { "type": "string", "enum": [ "neutral", "warm", "excited", "serious", "calm" ], "description": "Scene register." } } }, { "type": "object", "required": [ "from_library" ], "additionalProperties": false, "properties": { "from_library": { "type": "string", "description": "A saved scene's name or id (list_scenes), footage and media included — no AI cost." }, "params": { "type": "object", "description": "Values for its {{placeholders}}." } } } ] }, "description": "The scenes, in order, 1-20, all validated before anything is charged. On top of the render, a still (data.generate) costs 40 and a clip (data.clip) 311, refunded if it fails." }, "aspect_ratio": { "default": "16:9", "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ], "description": "16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds." }, "language": { "default": "en", "type": "string", "description": "As create_video. Write the narration in it." }, "voice": { "default": "auto", "type": "string", "description": "As create_video." }, "music": { "default": "auto", "type": "string", "description": "As create_video." }, "tone": { "default": "energetic", "type": "string", "description": "As create_video." }, "subtitles": { "default": true, "type": "boolean", "description": "As create_video." }, "intro": { "default": true, "type": "boolean", "description": "Include the branded opening title card." }, "outro": { "default": true, "type": "boolean", "description": "As create_video." }, "target_seconds": { "type": "integer", "minimum": 15, "maximum": 180, "description": "A check, not a setting: your words set the length. A script over 15% off is refused before any credit moves, with the words to cut or add. Omitted: the scenes alone must run at least 15 s, the film at most 180 s." }, "title": { "type": "string", "maxLength": 90, "description": "Name for the video. Defaults to the first scene's heading." }, "brand_name": { "type": "string", "maxLength": 60, "description": "Name shown on the intro and outro cards." }, "cta_text": { "type": "string", "maxLength": 60, "description": "Call to action on the closing card." }, "source_url": { "type": "string", "format": "uri", "description": "Attribution only; nothing is fetched or filmed." }, "theme": { "type": "object", "description": "As create_video. Omitted: the house palette." }, "look": { "default": "auto", "type": "string", "enum": [ "clean", "bold", "editorial", "playful", "tech", "auto" ], "description": "As create_video." }, "caption_style": { "type": "string", "enum": [ "karaoke", "bold", "boxed", "minimal", "outline" ], "description": "As create_video." }, "caption_animation": { "type": "string", "enum": [ "none", "pop", "bounce", "wave", "glow", "slide" ], "description": "As create_video." }, "caption_emphasis": { "type": "string", "enum": [ "manual", "auto", "none" ], "description": "As create_video." }, "grade": { "type": "string", "enum": [ "none", "warm", "cool", "vivid", "mono", "vintage", "contrast" ], "description": "As create_video." }, "sfx_level": { "type": "string", "enum": [ "off", "subtle", "full" ], "description": "As create_video." }, "callout": { "type": "string", "enum": [ "none", "ring", "arrow", "underline", "dim" ], "description": "As create_video." }, "cursor_style": { "type": "string", "enum": [ "arrow", "hand", "dot", "none" ], "description": "As create_video." }, "press_effect": { "type": "string", "enum": [ "punch", "freeze", "slowmo", "none" ], "description": "As create_video." }, "end_screen": { "type": "string", "enum": [ "cta", "qr", "social", "logo", "none" ], "description": "As create_video." }, "edit_style": { "type": "string", "enum": [ "tiktok_punchy", "documentary", "corporate", "cinematic" ], "description": "As create_video." }, "pronunciations": { "type": "array", "description": "As create_video." }, "generate_motion": { "type": "boolean", "description": "As create_video." }, "ai_mode": { "type": "string", "enum": [ "none", "assist", "rich" ], "description": "As create_video. Server picks scenes and prompts; omitted: data.generate only." }, "ai_budget": { "type": "object", "properties": { "max_clips": { "type": "integer", "minimum": 0 }, "max_images": { "type": "integer", "minimum": 0 }, "on_exceed": { "type": "string", "enum": [ "refuse", "queue", "fallback" ], "description": "Over the ceiling. refuse (default): create_animation creates nothing; create_video, planned after the call, keeps to the ceiling. fallback: renders, generating only up to the ceiling. queue: generates all." } }, "description": "A ceiling on this render's AI generation; the receipt's ai_plan says what was asked for and its cost. Omitted: uncapped." }, "model": { "type": "string", "description": "As create_video." }, "character": { "type": "string", "minLength": 1, "maxLength": 60, "description": "With ai_mode: in every added shot." }, "objects": { "type": "array", "items": { "type": "string" }, "maxItems": 3, "description": "With ai_mode: in every added shot." }, "idempotency_key": { "type": "string", "description": "As create_video." }, "outputs": { "type": "array", "description": "As create_video." }, "draft": { "type": "boolean", "description": "As create_video." }, "callback_url": { "type": "string", "description": "As create_video." }, "dry_run": { "type": "boolean", "description": "Quote only; nothing made or charged." }, "max_credits": { "type": "integer", "minimum": 0, "maximum": 1000000, "description": "Refuse (budget_exceeded + quote) above this." } }, "required": [ "scenes" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "site_url": { "type": "string", "format": "uri", "description": "Any public http(s) URL on the site the format belongs to; the site is identified by its domain." }, "name": { "type": "string", "minLength": 1, "maxLength": 80, "description": "The format's name, e.g. \"Le mot du chantier\". Available as {{show}} in templates." }, "kind": { "default": "video", "type": "string", "enum": [ "video", "animation" ], "description": "video: episodes film the item's page. animation: episodes are drawn from `scenes` with the item's data filled in." }, "goal": { "default": "explainer", "type": "string", "enum": [ "explainer", "ad", "demo", "tutorial", "article" ], "description": "What the video is for; shapes the script." }, "aspect_ratio": { "default": "16:9", "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ], "description": "16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds." }, "language": { "default": "en", "type": "string", "enum": [ "en", "fr", "es", "de", "it", "pt", "nl", "ar", "hi", "ko", "pl", "tr", "sv" ], "description": "Language of the voiceover and captions. Write the narration in this language." }, "target_seconds": { "type": "integer", "minimum": 15, "maximum": 180, "description": "A check, not a setting: your words set the length. A script over 15% off is refused before any credit moves, with the words to cut or add. Omitted: the scenes alone must run at least 15 s, the film at most 180 s." }, "tone": { "default": "energetic", "type": "string", "maxLength": 80, "description": "Delivery of the narration, up to 80 characters — e.g. energetic, calm, authoritative, or a short direction like \"dry and deadpan, like a friend telling a story\"." }, "voice": { "default": "auto", "type": "string", "enum": [ "auto", "Kore", "Zephyr", "Puck", "Charon", "Aoede", "Fenrir", "Leda", "Orus", "Callirrhoe", "Achird", "Sulafat", "Sadachbia" ], "description": "Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films." }, "music": { "default": "auto", "type": "string", "anyOf": [ { "enum": [ "auto", "none", "uplift", "corporate", "chill", "cinematic", "ambient", "pulse", "playful", "warm" ] }, { "pattern": "^asset:[A-Za-z0-9_-]{1,64}$" } ], "description": "Music bed, \"none\", or \"asset:<id>\" (upload_asset). auto fits the goal and differs from the site's previous films." }, "subtitles": { "default": true, "type": "boolean", "description": "Burn captions into the picture and emit a .vtt sidecar." }, "intro": { "default": true, "type": "boolean", "description": "Include the branded opening title card." }, "outro": { "default": true, "type": "boolean", "description": "Include the closing call-to-action card." }, "brand_name": { "type": "string", "maxLength": 60, "description": "Name shown on the intro and outro cards." }, "theme": { "type": "object", "description": "As create_video." }, "focus_template": { "type": "string", "maxLength": 2000, "description": "video formats: the brief every episode's script writer gets, with {{title}} {{summary}} {{link}} {{date}} {{image}} {{show}} {{site}} filled from the item." }, "title_template": { "type": "string", "maxLength": 120, "description": "animation formats: the episode's title, same placeholders. Default \"{{show}} — {{title}}\"." }, "scenes": { "type": "array", "description": "animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string." }, "programme": { "type": "object", "description": "animation formats: the programme instead of plain scenes. {beats: [...], resolvers: [...], computed: {...}, requires_beats: [...], reject_if: [...]}. A beat is a scene (visual, motion, mood, heading, caption, narration, data) plus beat (one of cold_open, title, identity, context, trend, breakdown, outlier, comparison, caveats, verdict, sources), when (an expression; dropped when not true) and for_each (an expression yielding a list; repeated per element). Any string may carry {{ expressions }} — dotted paths and filters such as money(EUR,M), percent(0), say, sort_by(year), take_last(6), map({label: year, value: total}) — and any field may be {\"$bind\": \"expression\"} to receive a real number, list or object (a chart's points). Resolvers fetch data before compiling: {id, call: {mcp: alias, tool, input} | {http: url, query, body}, select, required, on_missing: skip_episode | drop_beats(a,b) | use_default | fail_loud, cache: \"30d\"}; each reads what the ones before it bound. Every numeral in a narration or caption must come from an expression: a figure typed by hand fails validation by beat. validate_format checks the template; preview_episode runs the resolvers and compiles a real episode for free." }, "routing": { "type": "object", "description": "How episodes are made: {planner?: flash|pro, footage?: prefer-recorded|record-fresh}. flash is the benched default (it beat every larger model under the real prompt); pro is a deliberate choice. prefer-recorded uses the site's banked flow recordings when they match a scene; record-fresh films every episode anew, for a subject that changes each time." } }, "required": [ "site_url", "name" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60, "description": "The object's name, e.g. \"Aurora watch\". Scenes name it." }, "kind": { "type": "string", "enum": [ "product", "bag", "watch", "logo", "packaging", "place", "vehicle", "ui_screen", "other" ], "description": "What it is." }, "refs": { "type": "array", "minItems": 1, "maxItems": 6, "items": { "type": "string" }, "description": "1-6 reference images, best first: asset ids (list_assets) or media URLs on this account." }, "description": { "type": [ "string", "null" ], "maxLength": 300, "description": "One line added to every prompt that names it." }, "site_url": { "type": "string", "format": "uri", "description": "Scope it to one of your sites." }, "source_url": { "type": "string", "format": "uri", "description": "Where it comes from (a product page). Attribution only." }, "metadata": { "type": "object", "additionalProperties": false, "properties": { "price": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" } }, "description": "{price, currency (ISO 4217), brand, sku, url}. A price is drawn on pricing/compare/image cards." } }, "required": [ "name", "kind", "refs" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "site_url": { "type": "string", "format": "uri", "description": "Any public http(s) URL on the site; the site is identified by its domain." }, "name": { "type": "string", "minLength": 1, "maxLength": 80, "description": "The show's name, e.g. \"Le mot du chantier\". Available as {{show}} in templates." }, "kind": { "default": "video", "type": "string", "enum": [ "video", "animation" ], "description": "video: each episode films the item's own page (like create_video) with focus_template as its brief. animation: each episode is drawn from `scenes` (like create_animation) with the item's data filled in." }, "feed_kind": { "default": "rss", "type": "string", "enum": [ "rss", "json", "manual", "query", "watchlist", "webhook" ], "description": "rss: RSS/Atom. json: a JSON Feed or any JSON API via feed_map. query: one call per run on a registered connection (`source`). watchlist: the fixed items in `watchlist`. webhook: another system POSTs items to the show's webhook URL, signed with the secret returned once (X-PageToVid-Signature: sha256=HMAC of the body); cadence manual. manual: items passed to run_show, never scheduled." }, "feed_url": { "type": "string", "format": "uri", "description": "The feed's public URL for rss and json. It is read once now to make sure it parses." }, "source": { "type": "object", "description": "feed_kind query: {call: {mcp: alias, tool, input} | {http: url, query}, select: an expression into the answer that yields the list, map: dotted paths from an element to the item ({id, title, summary, link, image, date})}. Strings in the input may carry {{ show }}, {{ site }} and {{ now }}. Called once now to make sure it answers." }, "watchlist": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "object", "required": [ "title" ], "properties": { "key": { "type": "string" }, "title": { "type": "string", "maxLength": 200 }, "summary": { "type": "string", "maxLength": 600 }, "link": { "type": "string" }, "image": { "type": "string" }, "date": { "type": "string" } } }, "description": "feed_kind watchlist: the items, as run_show takes them. Each is made once — or once per period with repeat_every." }, "repeat_every": { "default": "none", "type": "string", "enum": [ "none", "month", "quarter", "year" ], "description": "query and watchlist shows: make every item again each period (the period is in the episode key and available to a programme as {{ item.period }}). none: each item once, ever." }, "feed_map": { "type": "object", "description": "For feed_kind json when the document is not a JSON Feed: dotted paths, e.g. {\"items\":\"data.results\",\"id\":\"slug\",\"title\":\"name\",\"summary\":\"excerpt\",\"link\":\"href\",\"image\":\"cover.url\",\"date\":\"published_at\"}. `items` may be omitted when the document is an array." }, "cadence": { "type": "string", "enum": [ "manual", "hourly", "daily", "weekly" ], "description": "How often the scheduler runs the show once it is confirmed. manual: only when run_show is called. Default daily; manual for manual and webhook feeds." }, "max_episodes_per_run": { "default": 1, "type": "integer", "minimum": 1, "maximum": 10, "description": "Newest items first; at most this many episodes per run." }, "max_credits_per_day": { "default": 120, "type": "integer", "minimum": 40, "maximum": 2000, "description": "The show never spends more than this in a UTC day, however many items the feed gains. An episode is 40 credits." }, "format_id": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Run an existing format (create_format / list_formats) instead of the fields below; its kind must match. Without it, the fields below become the show's own format, version 1, editable later with update_format." }, "format_version": { "type": "integer", "minimum": 1, "maximum": 100000, "description": "With format_id: pin the show to this version. Omitted, the show follows the format's latest version." }, "goal": { "default": "explainer", "type": "string", "enum": [ "explainer", "ad", "demo", "tutorial", "article" ], "description": "As create_format." }, "aspect_ratio": { "default": "16:9", "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ], "description": "As create_format." }, "language": { "default": "en", "type": "string", "description": "As create_format." }, "target_seconds": { "type": "integer", "description": "As create_format." }, "tone": { "default": "energetic", "type": "string", "description": "As create_format." }, "voice": { "default": "auto", "type": "string", "description": "As create_format." }, "music": { "default": "auto", "type": "string", "description": "As create_format." }, "subtitles": { "default": true, "type": "boolean", "description": "As create_format." }, "intro": { "default": true, "type": "boolean", "description": "As create_format." }, "outro": { "default": true, "type": "boolean", "description": "As create_format." }, "brand_name": { "type": "string", "description": "As create_format." }, "theme": { "type": "object", "description": "As create_video." }, "focus_template": { "type": "string", "description": "As create_format. Omitted: a brief leading with the item's title and summary." }, "title_template": { "type": "string", "description": "As create_format." }, "scenes": { "type": "array", "description": "As create_format. An image scene whose {{image}} is empty for an item is dropped from that episode." }, "routing": { "type": "object", "description": "As create_format." } }, "required": [ "site_url", "name" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "Public http(s) page to film; you must have the right to." }, "goal": { "default": "explainer", "type": "string", "enum": [ "explainer", "ad", "demo", "tutorial", "article" ], "description": "What the video is for; shapes the script." }, "aspect_ratio": { "default": "16:9", "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ], "description": "9:16 (Reels/Shorts) films the page's MOBILE layout in a phone viewport; 16:9, 1:1 and 4:5 film the 1280-wide desktop layout." }, "language": { "type": "string", "enum": [ "en", "fr", "es", "de", "it", "pt", "nl", "ar", "hi", "ko", "pl", "tr", "sv" ], "description": "Language of the script and voiceover. Omitted: the page's own language, else its country domain's (.fr, .de…), else the account's." }, "target_seconds": { "default": 45, "type": "integer", "minimum": 15, "maximum": 180, "description": "Length asked for: the words are written to fit it." }, "subtitles": { "default": true, "type": "boolean", "description": "Burn captions in and emit a .vtt sidecar." }, "tone": { "default": "energetic", "type": "string", "maxLength": 80, "description": "Narration delivery, e.g. calm, or a short direction." }, "voice": { "default": "auto", "type": "string", "enum": [ "auto", "Kore", "Zephyr", "Puck", "Charon", "Aoede", "Fenrir", "Leda", "Orus", "Callirrhoe", "Achird", "Sulafat", "Sadachbia" ], "description": "Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films." }, "music": { "default": "auto", "type": "string", "anyOf": [ { "enum": [ "auto", "none", "uplift", "corporate", "chill", "cinematic", "ambient", "pulse", "playful", "warm" ] }, { "pattern": "^asset:[A-Za-z0-9_-]{1,64}$" } ], "description": "Music bed, \"none\", or \"asset:<id>\" (upload_asset). auto fits the goal and differs from the site's previous films." }, "brand_name": { "type": "string", "maxLength": 60, "description": "Name on the intro and outro cards; default the site's." }, "focus": { "type": "string", "maxLength": 2000, "description": "Context the page cannot show (an offer, the audience, a code, what to avoid). Anything here may be voiced as FACT in the customer's voice; a line in quotation marks is placed verbatim, usually as the hook." }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 128, "description": "Same key within 24 h returns the original video, uncharged. Without one, an identical call within 120 s returns the first video (idempotent_replay)." }, "theme": { "type": "object", "additionalProperties": false, "properties": { "mode": { "type": "string", "enum": [ "dark", "light", "brand" ], "description": "dark (default), light, or brand (your colours fill the frame, white type)." }, "colors": { "type": "array", "maxItems": 2, "items": { "type": "string", "pattern": "^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$" }, "description": "Up to 2 hex accents, most important first, with real chroma and distinct hues; one the film cannot paint with is refused with the measurement. detect_brand reads a site's." }, "font": { "type": "string", "enum": [ "sans", "serif", "mono" ], "description": "Type category. Implied by font_family when you set one." }, "font_family": { "type": "string", "description": "A face from list_themes; any other is refused." }, "corners": { "type": "string", "enum": [ "sharp", "soft", "round" ], "description": "Corner language for cards, chips and bars." }, "positive": { "type": "string", "description": "Hex colour washed over a scene marked mood WIN. Defaults to your first accent." }, "negative": { "type": "string", "description": "Hex colour washed over a scene marked mood PROBLEM. Defaults to red." } }, "description": "Palette, type and mode; list_themes has the presets and rules, detect_brand reads a site's. Omitted: a filmed video adopts the page's CSS." }, "intro": { "type": "boolean", "description": "Opening title card (1.5 s). Omitted: true, except goal \"ad\" (opens on its hook)." }, "outro": { "default": true, "type": "boolean", "description": "Closing call-to-action card." }, "routing": { "type": "object", "description": "{planner?: flash|pro, footage?: prefer-recorded|record-fresh}. flash is the benched default (pro is a choice, not an upgrade); prefer-recorded reuses the site's banked flow recordings." }, "look": { "default": "auto", "type": "string", "enum": [ "clean", "bold", "editorial", "playful", "tech", "auto" ], "description": "The film's look: captions, cutting, sound cues, music family and motion together; auto varies with goal, shape and the site's films (list_video_options)." }, "caption_style": { "type": "string", "enum": [ "karaoke", "bold", "boxed", "minimal", "outline" ], "description": "Overrides the look's captions." }, "caption_animation": { "type": "string", "enum": [ "none", "pop", "bounce", "wave", "glow", "slide" ], "description": "What a spoken word does; overrides the look's." }, "caption_emphasis": { "type": "string", "enum": [ "manual", "auto", "none" ], "description": "Brand-coloured words: **asterisked** (manual), plus figures (auto), or none." }, "grade": { "type": "string", "enum": [ "none", "warm", "cool", "vivid", "mono", "vintage", "contrast" ], "description": "Footage colour grade; overrides the look's." }, "sfx_level": { "type": "string", "enum": [ "off", "subtle", "full" ], "description": "Sound-design loudness; overrides the look's." }, "callout": { "type": "string", "enum": [ "none", "ring", "arrow", "underline", "dim" ], "description": "What points at a screencast's subject." }, "cursor_style": { "type": "string", "enum": [ "arrow", "hand", "dot", "none" ], "description": "The pointer a recording draws." }, "press_effect": { "type": "string", "enum": [ "punch", "freeze", "slowmo", "none" ], "description": "What the picture does on a click." }, "end_screen": { "type": "string", "enum": [ "cta", "qr", "social", "logo", "none" ], "description": "The closing card." }, "edit_style": { "type": "string", "enum": [ "tiktok_punchy", "documentary", "corporate", "cinematic" ], "description": "Cutting rhythm (list_motions); a scene's own transition still wins." }, "ai_mode": { "type": "string", "enum": [ "none", "assist", "rich" ], "description": "AI visuals for beats the page cannot show (paid plans): none; assist = a few stills; rich = stills and clips within ai_budget. Omitted: assist where the plan generates, else none. Charged per visual, refunded on failure." }, "ai_budget": { "type": "object", "properties": { "max_clips": { "type": "integer", "minimum": 0 }, "max_images": { "type": "integer", "minimum": 0 }, "on_exceed": { "type": "string", "enum": [ "refuse", "queue", "fallback" ], "description": "Over the ceiling. refuse (default): create_animation creates nothing; create_video, planned after the call, keeps to the ceiling. fallback: renders, generating only up to the ceiling. queue: generates all." } }, "description": "Ceiling on AI visuals, given to the planner." }, "model": { "type": "string", "maxLength": 60, "description": "Clip model (list_models) for ai_mode rich, or auto (routed per scene, see optimize); omit for the house clip." }, "optimize": { "type": "string", "enum": [ "quality", "balanced", "speed", "cost" ], "description": "With model auto: quality, balanced (default), speed or cost." }, "quality_gate": { "type": "object", "additionalProperties": false, "properties": { "min_score": { "type": "number", "minimum": 0, "maximum": 100 }, "on_fail": { "type": "string", "enum": [ "auto_fix", "hold", "deliver" ] } }, "description": "auto_fix (default): dead air and colliding overlays fixed before rendering (auto_fixes). hold: also, a film scored under min_score ends \"held\" until release_video. deliver: as authored." }, "generate_motion": { "type": "boolean", "description": "Custom motion graphics for beats no built-in visual fits (AI plans or a film pass, else built-in)." }, "outputs": { "type": "array", "minItems": 1, "maxItems": 4, "uniqueItems": true, "items": { "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ] }, "description": "One storyboard in 1-4 shapes: the first is this video (replaces aspect_ratio), each other a sibling (get_video formats), a render each, started when the first ends." }, "draft": { "type": "boolean", "description": "Free preview: 1/3 resolution, DRAFT mark, no AI visuals. 5/hour. rerender_video without draft then makes the paid film, no re-plan." }, "callback_url": { "type": "string", "format": "uri", "description": "https URL POSTed a JSON event when the render ends (done/held/error/cancelled), 3 tries. Verify: X-PageToVid-Signature = \"sha256=\" + hex HMAC-SHA256(secret, X-PageToVid-Timestamp + \".\" + raw body); refuse timestamps over 5 min old. Secret: webhook_secret, shown once, or rotate_webhook_secret." }, "dry_run": { "type": "boolean", "description": "Quote only; nothing made or charged." }, "max_credits": { "type": "integer", "minimum": 0, "maximum": 1000000, "description": "Refuse (budget_exceeded + quote) above this." }, "pronunciations": { "type": "array", "maxItems": 50, "items": { "type": "object", "required": [ "text", "say" ], "additionalProperties": false, "properties": { "text": { "type": "string", "maxLength": 60 }, "say": { "type": "string", "maxLength": 120 } } }, "description": "Voice-only lexicon, e.g. [{\"text\":\"Nginx\",\"say\":\"engine x\"}]; captions keep the text." } }, "required": [ "url" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "kind": { "type": "string", "enum": [ "image", "video" ], "description": "image (a still) or video (a clip). Default image." }, "prompt": { "type": "string", "minLength": 3, "maxLength": 600, "description": "What to draw or film." }, "aspect_ratio": { "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5", "21:9" ], "description": "Default 16:9. 21:9 and 4:5 only where list_models says the model takes them." }, "model": { "type": "string", "maxLength": 60, "description": "list_models id, house, house-image, or auto (clips; see optimize)." }, "count": { "type": "integer", "minimum": 1, "maximum": 4, "description": "Stills: how many, each charged." }, "optimize": { "type": "string", "enum": [ "quality", "balanced", "speed", "cost" ], "description": "For model auto. Default balanced." }, "duration_s": { "type": "integer", "minimum": 1, "maximum": 60, "description": "Seconds (list_models range)." }, "resolution": { "type": "string", "enum": [ "480p", "720p", "768p", "1080p", "2k", "4k" ], "description": "One the model offers." }, "first_frame": { "type": "string", "minLength": 1, "maxLength": 600, "description": "Bank image id/URL to start on." }, "last_frame": { "type": "string", "minLength": 1, "maxLength": 600, "description": "Bank image to end on." }, "seed": { "type": "integer", "minimum": 0, "maximum": 4294967295, "description": "Where the model takes one." }, "negative_prompt": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Where the model takes one." }, "camera": { "type": "object", "properties": { "move": { "type": "string", "enum": [ "static", "pan_left", "pan_right", "tilt_up", "tilt_down", "dolly_in", "dolly_out", "orbit", "handheld" ] }, "speed": { "type": "string", "enum": [ "slow", "medium", "fast" ] } }, "required": [ "move" ], "additionalProperties": false, "description": "Folded into the prompt." }, "shot": { "type": "string", "enum": [ "wide", "medium", "close_up" ], "description": "Folded into the prompt." }, "best_of": { "type": "integer", "minimum": 1, "maximum": 4, "description": "N graded, best kept, all charged." }, "dry_run": { "type": "boolean", "description": "Quote only; nothing made or charged." }, "max_credits": { "type": "integer", "minimum": 0, "maximum": 1000000, "description": "Refuse (budget_exceeded + quote) above this." }, "character": { "type": "string", "maxLength": 60, "description": "A character from create_character, so the same face comes back." }, "objects": { "type": "array", "maxItems": 8, "items": { "type": "string" }, "description": "Object names (list_objects) kept consistent, after the character." }, "tags": { "type": "string", "maxLength": 400, "description": "Comma-separated tags, to find it again." }, "site_url": { "type": "string", "format": "uri", "description": "Attach it to one of your sites." }, "idempotency_key": { "type": "string", "minLength": 8, "maxLength": 128, "description": "Same key within 24 h returns what it made, uncharged. Without one, an identical call within 10 min does; one still running is reported, not restarted." } }, "required": [ "prompt" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "site_url": { "type": "string", "format": "uri", "description": "Any public http(s) URL on the site; the site is identified by its domain." }, "idea_ids": { "type": "array", "minItems": 1, "items": { "type": "string" }, "description": "Which ideas from get_site_plan to make, in order. Omitted: every idea that has no video yet." }, "url": { "type": "string", "format": "uri", "description": "The page to film for every video. Omitted, each idea films its own verified page (page_url in get_site_plan)." }, "aspect_ratio": { "default": "16:9", "type": "string", "enum": [ "16:9", "9:16", "1:1", "4:5" ], "description": "As create_video." }, "language": { "default": "en", "type": "string", "description": "As create_video." }, "voice": { "default": "auto", "type": "string", "description": "As create_video." }, "music": { "default": "auto", "type": "string", "description": "As create_video." }, "subtitles": { "default": true, "type": "boolean", "description": "As create_video." }, "intro": { "default": true, "type": "boolean", "description": "Include the branded opening title card." }, "outro": { "default": true, "type": "boolean", "description": "As create_video." }, "brand_name": { "type": "string", "maxLength": 60, "description": "Name shown on the intro and outro cards." }, "theme": { "type": "object", "description": "As create_video." }, "look": { "default": "auto", "type": "string", "enum": [ "clean", "bold", "editorial", "playful", "tech", "auto" ], "description": "As create_video." }, "caption_style": { "type": "string", "enum": [ "karaoke", "bold", "boxed", "minimal", "outline" ], "description": "As create_video." }, "confirm": { "default": false, "type": "boolean", "description": "false (the default) previews the videos and spends nothing. true starts them and spends 40 credits each." }, "max_videos": { "default": 5, "type": "integer", "minimum": 1, "maximum": 10, "description": "At most this many videos in one call. Call again for the rest." } }, "required": [ "site_url" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

{ "type": "object", "properties": { "items": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "object", "required": [ "name", "image_url" ], "additionalProperties": false, "properties": { "name": { "type": "string", "maxLength": 60 }, "image_url": { "type": [ "string", "array" ], "items": { "type": "string" } }, "kind": { "type": "string", "enum": [ "product", "bag", "watch", "logo", "packaging", "place", "vehicle", "ui_screen", "other" ] }, "description": { "type": "string", "maxLength": 300 }, "price": { "type": [ "number", "string" ] }, "currency": { "type": "string" }, "brand": { "type": "string" }, "sku": { "type": "string" }, "url": { "type": "string" } } }, "description": "1-50 catalogue rows. image_url: one public image URL or a list (best first, up to 6); kind defaults to product." }, "site_url": { "type": "string", "format": "uri", "description": "Scope it to one of your sites." } }, "required": [ "items" ], "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false }

Endpoint health

Machine-readable profile

Connect this server

Indexed tools

Stop a render and get the credits back

Copy a scene into another video

Connections

Links

Endpoint health

Machine-readable profile

Connect this server

Indexed tools

Stop a render and get the credits back

Copy a scene into another video

Connections

Links

Create an animated video from your own content

Create a reusable character for consistent clips

Create a format: the reusable shape of a programme

Design a motion graphic

Create a reusable object

Create a show: a recurring video from a feed

Create video from web page

Delete an object

Read a site's colours and typography

Copy a format

Generate one image or clip, without making a video

Make the videos a site's plan asks for

Get plan and credit balance

Read a format and its versions

Get the video plan for a whole site

Get the scenes of a video

Get video status and links

Get embed and SEO tags for a video

Import a catalogue as objects

See what is on a page worth filming

List the account's own media bank

List the account's characters

Browse the asset commons