Turn any web page into a narrated video: films the real site, writes, voices and captions it
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Optional: a PageToVid API key from https://pagetovid.com/account. Clients that support OAuth (Claude, ChatGPT) connect without one.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
[Free] Adds a timestamped comment; open comments feed the editor's AI revision.
The comment.
The video's id.
Moment in the film, seconds.
From get_storyboard.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Tool list last changed Oct 25, 2026.
[Free] Adds a timestamped comment; open comments feed the editor's AI revision.
| Argument | Type | Description |
|---|---|---|
| at_s | number | Moment in the film, seconds. |
| text* | string | The comment. |
| scene_id | string | From get_storyboard. |
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"text"
],
"properties": {
"at_s": {
"type": "number",
"maximum": 36000,
"minimum": 0,
"description": "Moment in the film, seconds."
},
"text": {
"type": "string",
"maxLength": 600,
"minLength": 1,
"description": "The comment."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"description": "From get_storyboard."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[Free] Approves the pending round, as one of its approvers.
| Argument | Type | Description |
|---|---|---|
| comment | string | Optional note. |
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"comment": {
"type": "string",
"maxLength": 2000,
"description": "Optional note."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[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.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The running video to stop. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The running video to stop."
}
},
"additionalProperties": false
}[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.
| Argument | Type | Description |
|---|---|---|
| scene_id* | string | The scene to copy, from get_storyboard. |
| to_video_id* | string | The video to copy it into (may be the same one). |
| from_video_id* | string | The video the scene is in. |
| after_scene_id | string | Put it after this scene of the target. Omitted: at the end. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"from_video_id",
"scene_id",
"to_video_id"
],
"properties": {
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to copy, from get_storyboard."
},
"to_video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video to copy it into (may be the same one)."
},
"from_video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video the scene is in."
},
"after_scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Put it after this scene of the target. Omitted: at the end."
}
},
"additionalProperties": false
}[40 credits] From content you hold (figures, notes, story), no URL. You write scenes; each drawn, voiced, captioned (list_motions: 25 visuals, some with kinds; visual "rushie" = 664 designed cards, e.g. data {rushie:{template:"end-card",props:{headline,mark,url,cta}}}). AI clips (paid plans) only if asked: data.generate (+data.clip) per scene, or ai_mode rich (assist: stills), the server picks scenes, writes prompts; dry_run shows ai_plan.added. Returns a receipt; get_video for the full status.
| Argument | Type | Description |
|---|---|---|
| look | string | As create_video. |
| tone | string | As create_video. |
| draft | boolean | As create_video. |
| grade | string | As create_video. |
| intro | boolean | Include the branded opening title card. |
| model | string | As create_video. |
| music | string | As create_video. |
| outro | boolean | As create_video. |
| theme | object | As create_video. Omitted: the house palette. |
[Free or 40 credits] Names a character so generated clips that name it keep one identity. refs (1 to 3 image URLs on this account) is free; a generate prompt DRAWS the reference (paid plans, refunded on failure). Then an image scene's data.clip=true and data.character="<name>". From one of your films take raw_frame_url, never thumbnail_url: its burnt-in text teaches the generator to draw text.
| Argument | Type | Description |
|---|---|---|
| name* | string | The character's name, e.g. "Ada, the founder". A clip scene names it in data.character to stay consistent. |
| refs | array | 1 to 3 reference image URLs — media on this account (a generated still, a bank asset, a commons asset from list_commons_assets). These become Veo's ingredients so the same character recurs. Give these OR a generate prompt. |
| generate | string | Draw the reference portrait instead of supplying one — e.g. "a woman in her late twenties, platinum blonde, grey tee". Paid plans: 40 credits (one still), refunded if it fails. Ignored when refs are given. |
| site_url | string | Scope the character to one site. |
| description | string | A short line describing the character, added to every clip's prompt so words and image agree. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The character's name, e.g. \"Ada, the founder\". A clip scene names it in data.character to stay consistent."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "1 to 3 reference image URLs — media on this account (a generated still, a bank asset, a commons asset from list_commons_assets). These become Veo's ingredients so the same character recurs. Give these OR a generate prompt."
},
"generate": {
"type": "string",
"maxLength": 600,
"minLength": 3,
"description": "Draw the reference portrait instead of supplying one — e.g. \"a woman in her late twenties, platinum blonde, grey tee\". Paid plans: 40 credits (one still), refunded if it fails. Ignored when refs are given."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Scope the character to one site."
},
"description": {
"type": "string",
"maxLength": 300,
"description": "A short line describing the character, added to every clip's prompt so words and image agree."
}
},
"additionalProperties": false
}[Free] A format is how an episode is made — aspect, language, voice, music, tone, goal, length, cards, brand, theme, the brief or the scene templates — and knows nothing about any subject. It is versioned: update_format writes a new version, shows pin one or follow latest, and every episode records the version that made it. Validated now against a sample item; nothing is rendered.
| Argument | Type | Description |
|---|---|---|
| goal | string | What the video is for; shapes the script. |
| kind | string | video: episodes film the item's page. animation: episodes are drawn from `scenes` with the item's data filled in. |
| name* | string | The format's name, e.g. "Le mot du chantier". Available as {{show}} in templates. |
| tone | string | 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". |
| intro | boolean | Include the branded opening title card. |
| music | string | Music bed, "none", or "asset:<id>" (upload_asset). auto fits the goal and differs from the site's previous films. |
| outro | boolean | Include the closing call-to-action card. |
| theme |
[Paid plans] Designs a custom motion graphic from a brief (one text-model call; AI plans or a film pass; no credits charged), checks layout, legibility, contrast and timing, and saves it as a private template with params. Use it in a scene: visual "motion", data {motion:{specId, params}}.
| Argument | Type | Description |
|---|---|---|
| name | string | A name for the template. |
| tags | array | Labels to find it by. |
| brief* | string | What the scene shows and says, with its facts and figures. |
| language | string | On-screen language (default en). |
| site_url | string | Use this site's brand kit colours. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"brief"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "A name for the template."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 12,
"description": "Labels to find it by."
},
"brief": {
"type": "string",
"maxLength": 600,
"minLength": 8,
"description": "What the scene shows and says, with its facts and figures."
},
"language": {
"type": "string",
"maxLength": 10,
"minLength": 2,
"description": "On-screen language (default en)."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Use this site's brand kit colours."
}
},
"additionalProperties": false
}[Free] Names a product, logo, packaging, place, vehicle or UI screen from reference images so films keep it identical. Generated pictures take it in data.objects (clips, stills, insets, generate_asset) next to a character; image, gallery, pricing and compare cards draw it from data.object with its name and price.
| Argument | Type | Description |
|---|---|---|
| kind* | string | What it is. |
| name* | string | The object's name, e.g. "Aurora watch". Scenes name it. |
| refs* | array | 1-6 reference images, best first: asset ids (list_assets) or media URLs on this account. |
| metadata | object | {price, currency (ISO 4217), brand, sku, url}. A price is drawn on pricing/compare/image cards. |
| site_url | string | Scope it to one of your sites. |
| source_url | string | Where it comes from (a product page). Attribution only. |
| description | string | null | One line added to every prompt that names it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"kind",
"refs"
],
"properties": {
"kind": {
"enum": [
"product",
"bag",
"watch",
"logo",
"packaging",
"place",
"vehicle",
"ui_screen",
"other"
],
"type": "string",
"description": "What it is."
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The object's name, e.g. \"Aurora watch\". Scenes name it."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "1-6 reference images, best first: asset ids (list_assets) or media URLs on this account."
},
"metadata": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"url": {
"type": "string"
},
"brand": {
"type": "string"
},
"price": {
"type": [
"number",
"string"
]
},
"currency": {
"type": "string"
}
},
"description": "{price, currency (ISO 4217), brand, sku, url}. A price is drawn on pricing/compare/image cards.",
"additionalProperties": false
},
"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."
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 300,
"description": "One line added to every prompt that names it."
}
},
"additionalProperties": false
}[Free] A link to watch the film and, if allowed, comment with no account. Shown once; only its hash is stored.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video's id. |
| can_comment | boolean | Guests may comment. |
| expires_in_hours | integer | Lifetime. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
},
"can_comment": {
"type": "boolean",
"default": true,
"description": "Guests may comment."
},
"expires_in_hours": {
"type": "integer",
"default": 168,
"maximum": 720,
"minimum": 1,
"description": "Lifetime."
}
},
"additionalProperties": false
}[Free] A show makes a video from each new item in a feed: a weekly release video from a changelog, a daily listing video from an RSS feed, a clip per new post. Episodes are ordinary videos made by run_show or, once confirmed, by the scheduler at the show's cadence. A new show is HELD: nothing renders until its owner has called run_show once with confirm=true, and it never spends more than max_credits_per_day.
| Argument | Type | Description |
|---|---|---|
| goal | string | As create_format. |
| kind | string | 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. |
| name* | string | The show's name, e.g. "Le mot du chantier". Available as {{show}} in templates. |
| tone | string | As create_format. |
| intro | boolean | As create_format. |
| music | string | As create_format. |
| outro | boolean | As create_format. |
| theme | object | As create_video. |
| voice | string |
[Free] A one-hour address to send a file you hold (picture, clip, music, font, PDF/PPTX deck, ≤ 30 MB): curl -sS -T <file> "<upload_url>". The reply is the asset or the deck's slides.
| Argument | Type | Description |
|---|---|---|
| kind | string | Read from the bytes if omitted. |
| name | string | A label. |
| site_url | string | Attach to this site. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"image",
"video",
"audio",
"font",
"deck"
],
"type": "string",
"description": "Read from the bytes if omitted."
},
"name": {
"type": "string",
"maxLength": 200,
"description": "A label."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Attach to this site."
}
},
"additionalProperties": false
}[40 credits] [paid plans: + 40 per AI still unless ai_mode none; dry_run quotes] Turns a public web page into a narrated video: AI voiceover, motion graphics, optional subtitles. Asynchronous (minutes, sometimes past fifteen): returns a receipt with the video_id at once; get_video for the full status. A page behind a login is filmed only with a capture session from the VS Code or browser extension (Scale plan and up).
| Argument | Type | Description |
|---|---|---|
| url* | string | Public http(s) page to film; you must have the right to. |
| goal | string | What the video is for; shapes the script. |
| look | string | 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). |
| tone | string | Narration delivery, e.g. calm, or a short direction. |
| draft | boolean | Free preview: 1/3 resolution, DRAFT mark, no AI visuals. 5/hour. rerender_video without draft then makes the paid film, no re-plan. |
| focus | string | 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. |
| grade | string | Footage colour grade; overrides the look's. |
[Free] Deletes a character by name. Its reference images stay in your bank and clips made with it stay in their films.
| Argument | Type | Description |
|---|---|---|
| name* | string | The character's current name. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The character's current name."
}
},
"additionalProperties": false
}[Free] Deletes an object by name. Its images stay in your bank and media made with it stays in its films.
| Argument | Type | Description |
|---|---|---|
| name* | string | The object to delete. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The object to delete."
}
},
"additionalProperties": false
}[Free] Reads a public page's design tokens from its live CSS: accent colours, heading typeface, light or dark ground, corner style. Returns a theme ready for create_video, create_animation or rerender_video, plus any site colour the film cannot paint with and why.
| Argument | Type | Description |
|---|---|---|
| url* | string | A public page of the site. A heavy home page can time out (read_failed); then try a content page. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "A public page of the site. A heavy home page can time out (read_failed); then try a content page."
}
},
"additionalProperties": false
}[Free] A new format whose version 1 is the original's latest version, unpinned from its parent. Edit the copy without touching the original.
| Argument | Type | Description |
|---|---|---|
| name | string | The copy's name. Default: the original's name with " (copy)". |
| site_url | string | The site the copy belongs to. Default: the original's site. |
| format_id* | string | The format_id from create_format or list_formats. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The copy's name. Default: the original's name with \" (copy)\"."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "The site the copy belongs to. Default: the original's site."
},
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The format_id from create_format or list_formats."
}
},
"additionalProperties": false
}[40 or 311 credits] One AI still (40 credits each) or clip (house 311, a named model its list_models price) straight into your bank — no render. Clip controls are refused, with the allowed values, when the model is not sent them; model auto picks one and says why. best_of makes N and keeps the best graded (all N charged). Charged before, refunded on failure; dry_run quotes it free. Paid plans.
| Argument | Type | Description |
|---|---|---|
| kind | string | image (a still) or video (a clip). Default image. |
| seed | integer | Where the model takes one. |
| shot | string | Folded into the prompt. |
| tags | string | Comma-separated tags, to find it again. |
| count | integer | Stills: how many, each charged. |
| model | string | list_models id, house, house-image, or auto (clips; see optimize). |
| camera | object | Folded into the prompt. |
| prompt* | string | What to draw or film. |
| best_of | integer | N graded, best kept, all charged. |
[40 credits] Per video started. One filmed video per get_site_plan idea without one (or the idea_ids given), of its verified page with its sourced brief as focus. Without confirm it lists what it would make and the cost, capped at the balance (the rest under needs_credits), creating nothing; confirm=true starts those. get_video reports each. A retry never starts an idea twice.
| Argument | Type | Description |
|---|---|---|
| url | string | The page to film for every video. Omitted, each idea films its own verified page (page_url in get_site_plan). |
| look | string | As create_video. |
| intro | boolean | Include the branded opening title card. |
| music | string | As create_video. |
| outro | boolean | As create_video. |
| theme | object | As create_video. |
| voice | string | As create_video. |
| confirm | boolean | false (the default) previews the videos and spends nothing. true starts them and spends 40 credits each. |
| idea_ids | array | Which ideas from get_site_plan to make, in order. Omitted: every idea that has no video yet. |
[Free] Reads this account. CALL THIS FIRST: plan, credits, whether AI visuals are available and charged, watermark, revisions, film passes, add-on clips, renders running, limits. Then: inspect_page (in the aspect you will film), create_video or create_animation, get_storyboard (the chosen shots), update_storyboard, rerender_video.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] Who did what here, newest first: members, spending, review links, approvals, comments.
| Argument | Type | Description |
|---|---|---|
| since | string | Only entries from this time on. |
| site_url | string | Only entries about this site. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"since": {
"type": "string",
"format": "date-time",
"description": "Only entries from this time on."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Only entries about this site."
}
},
"additionalProperties": false
}[Free] A site's brand kit, what a film paints from it (and what it cannot, with why), the effective watermark, and the account defaults beneath it.
| Argument | Type | Description |
|---|---|---|
| site_url* | string | Any URL of the site. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url"
],
"properties": {
"site_url": {
"type": "string",
"format": "uri",
"description": "Any URL of the site."
}
},
"additionalProperties": false
}[Free] The format's current template, its version history and the shows that run it, with each show's pin.
| Argument | Type | Description |
|---|---|---|
| format_id* | string | The format_id from create_format or list_formats. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format_id"
],
"properties": {
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The format_id from create_format or list_formats."
}
},
"additionalProperties": false
}[Free] JPEG stills (≤ 1280 px wide) cut from the finished MP4 at 1–6 moments in seconds, as URLs. Cached per render.
| Argument | Type | Description |
|---|---|---|
| times* | array | 1–6 times in seconds (0.1 s steps). |
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"times"
],
"properties": {
"times": {
"type": "array",
"items": {
"type": "number",
"minimum": 0
},
"maxItems": 6,
"minItems": 1,
"description": "1–6 times in seconds (0.1 s steps)."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[Free] The grammar for writing your own animation as a motion spec: no topic → a short index and the authoring loop; topic → one rule file (layers, params, timing, motion, colour, layout, doctrine, examples, brief). Generated from the DSL itself.
| Argument | Type | Description |
|---|---|---|
| topic | string | One topic; omit for the index. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"topic": {
"enum": [
"layers",
"params",
"timing",
"motion",
"colour",
"layout",
"doctrine",
"examples",
"brief"
],
"type": "string",
"description": "One topic; omit for the index."
}
},
"additionalProperties": false
}[Free] One template with its full spec (layers, motion tokens, declared params).
| Argument | Type | Description |
|---|---|---|
| template_id* | string | The template's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"template_id"
],
"properties": {
"template_id": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The template's id."
}
},
"additionalProperties": false
}[Free] Up to 5 ranked videos a site should have, one per subject: goal, pitch, the real page it films (checked), the video made; detail full adds the brief, sources and shots. First call generates it (~10-20 s, no credit), then banks the site's images, videos and page clips in the background (media counts them). generate_site_videos works from it.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many ideas, best first. |
| detail | string | short: title, goal, pitch, page and whether it was made. full: also the brief (focus), its sources, audience, tone and shots. |
| refresh | boolean | true regenerates the plan even if one exists, overwriting it. A plan is generated automatically the first time. |
| language | string | Language the ideas and shot list are written in. This is the planner's working language, not the videos' — generate_site_videos sets that. |
| site_url* | string | Any public http(s) URL on the site; the site is identified by its domain. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url"
],
"properties": {
"limit": {
"type": "integer",
"default": 5,
"maximum": 35,
"minimum": 1,
"description": "How many ideas, best first."
},
"detail": {
"enum": [
"short",
"full"
],
"type": "string",
"default": "short",
"description": "short: title, goal, pitch, page and whether it was made. full: also the brief (focus), its sources, audience, tone and shots."
},
"refresh": {
"type": "boolean",
"default": false,
"description": "true regenerates the plan even if one exists, overwriting it. A plan is generated automatically the first time."
},
"language": {
"enum": [
"en",
"fr",
"es",
"de",
"it",
"pt",
"nl",
"ar",
"hi",
"ko",
"pl",
"tr",
"sv"
],
"type": "string",
"default": "en",
"description": "Language the ideas and shot list are written in. This is the planner's working language, not the videos' — generate_site_videos sets that."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Any public http(s) URL on the site; the site is identified by its domain."
}
},
"additionalProperties": false
}[Free] Reads this account. Returns the scene-by-scene plan of a video: what each scene narrates, its on-screen caption, how long it holds, and whether it is real footage of the page or a motion graphic (and which motion).
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video_id to read. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video_id to read."
}
},
"additionalProperties": false
}[Free] Each scene's start and end in the finished MP4 (seconds), what drew it (recording, page still, AI clip/still, footage, graphic, card, inset), its transition, its slice of the one voice track with word onsets, plus the music and caption style. timeline_source: stored by the render, or rebuilt from the scenes.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[Free] Reads this account. The full status of a render: phase and progress while it runs (with poll_after_seconds), then the files, length, credits, warnings and quality; on a free film, `upgrade` to relay once. `status` is one of, in pipeline order: draft, queued, analyzing, scripting, recording, voicing, rendering, held, done, error. In flight, so poll again after poll_after_seconds: queued, analyzing, scripting, recording, voicing, rendering. Terminal, so stop polling: held, done, error — a cancelled render ends as error with the reason in `error`, and a film can be done and still carry warnings. held: finished but unpublished by quality_gate. draft has not been queued.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video_id returned by create_video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video_id returned by create_video."
}
},
"additionalProperties": false
}[Free] Returns ready-to-paste markup for a finished PageToVid video: an HTML video element, Open Graph and Twitter player meta tags so the page unfurls as a playable video, and a schema.org VideoObject JSON-LD block.
| Argument | Type | Description |
|---|---|---|
| title | string | Overrides the title in the share card. Defaults to the video's own title. |
| page_url | string | The page this markup will be pasted into. Used for og:url so a share resolves to your page rather than nothing. |
| video_id* | string | The video_id of a finished render. |
| description | string | Overrides the share description. Defaults to a sentence written in the video's language. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"description": "Overrides the title in the share card. Defaults to the video's own title."
},
"page_url": {
"type": "string",
"format": "uri",
"description": "The page this markup will be pasted into. Used for og:url so a share resolves to your page rather than nothing."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video_id of a finished render."
},
"description": {
"type": "string",
"maxLength": 300,
"description": "Overrides the share description. Defaults to a sentence written in the video's language."
}
},
"additionalProperties": false
}[Free] Creates or replaces up to 50 objects from a product feed. Each image is downloaded (public addresses only) and banked as a reference. Failed rows are listed with the reason.
| Argument | Type | Description |
|---|---|---|
| items* | array | 1-50 catalogue rows. image_url: one public image URL or a list (best first, up to 6); kind defaults to product. |
| site_url | string | Scope it to one of your sites. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"image_url"
],
"properties": {
"sku": {
"type": "string"
},
"url": {
"type": "string"
},
"kind": {
"enum": [
"product",
"bag",
"watch",
"logo",
"packaging",
"place",
"vehicle",
"ui_screen",
"other"
],
"type": "string"
},
"name": {
"type": "string",
"maxLength": 60
},
"brand": {
"type": "string"
},
"price": {
"type": [
"number",
"string"
]
},
"currency": {
"type": "string"
},
"image_url": {
"type": [
"string",
"array"
],
"items": {
"type": "string"
}
},
"description": {
"type": "string",
"maxLength": 300
}
},
"additionalProperties": false
},
"maxItems": 50,
"minItems": 1,
"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."
}
},
"additionalProperties": false
}[Free] Opens a public page in a real browser and ranks what a video could film — calls to action, images, cards, pricing, testimonials, search boxes, headings — each with a CSS selector, kind, size and score (a rank, not a percentage). Says when a robot check, sign-in or missing page stood in front of it (blocked, block_kind), and which fields will never be typed into.
| Argument | Type | Description |
|---|---|---|
| url* | string | A public page to look at. Nothing is filmed and no credit is spent. |
| kinds | string | Comma-separated kinds to keep, e.g. "cta,search,card". The vocabulary is in the `kinds` histogram of any reply: cta, media, image, card, pricing, testimonial, logos, heading, section, nav, search, chat, input. Omitted, every kind is offered. |
| limit | integer | How many candidates to return, best first (a page offers up to 40; a film uses four or five). The `kinds` histogram still counts every one. |
| aspect_ratio | string | The viewport to look through. 9:16 loads the page as a phone does, which is the layout a vertical video films — a responsive site offers different elements there (a sticky call bar, stacked cards) and they score differently. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "A public page to look at. Nothing is filmed and no credit is spent."
},
"kinds": {
"type": "string",
"maxLength": 120,
"description": "Comma-separated kinds to keep, e.g. \"cta,search,card\". The vocabulary is in the `kinds` histogram of any reply: cta, media, image, card, pricing, testimonial, logos, heading, section, nav, search, chat, input. Omitted, every kind is offered."
},
"limit": {
"type": "integer",
"default": 12,
"maximum": 40,
"minimum": 1,
"description": "How many candidates to return, best first (a page offers up to 40; a film uses four or five). The `kinds` histogram still counts every one."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"description": "The viewport to look through. 9:16 loads the page as a phone does, which is the layout a vertical video films — a responsive site offers different elements there (a sticky call bar, stacked cards) and they score differently."
}
},
"additionalProperties": false
}[Free] Emails an invite to this workspace with a role, optional site limits and monthly credit cap. Members spend the owner's credits. Seats incl. owner: Free/Creator 1, Pro 3, Scale 5, Business 15, Agency unlimited.
| Argument | Type | Description |
|---|---|---|
| role* | string | editor makes and spends; reviewer comments and approves. |
| email* | string | They join by signing in with it. |
| site_urls | array | null | Limit to these sites; null = all. |
| credit_cap | integer | null | Monthly credit cap; null = none. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"email",
"role"
],
"properties": {
"role": {
"enum": [
"admin",
"editor",
"reviewer",
"viewer",
"billing"
],
"type": "string",
"description": "editor makes and spends; reviewer comments and approves."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "They join by signing in with it."
},
"site_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 50,
"description": "Limit to these sites; null = all."
},
"credit_cap": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Monthly credit cap; null = none."
}
},
"additionalProperties": false
}[Free] Your PRIVATE bank: every image, clip and audio file, by origin and subject, with id, URL, brief, tags and facets. Reuse a picture by putting its id in an image scene as data.asset_id (a clip resolves to clipUrl by itself); an audio asset is a film's music as "asset:<id>". Reusing costs no credit.
| Argument | Type | Description |
|---|---|---|
| q | string | Words, and/or facets origin: subject: camera: light: look: mood: orientation: |
| kind | string | Only images, clips, uploaded audio or fonts. |
| limit | integer | At most this many, newest first (default 40). |
| site_url | string | Only assets attached to this site. |
| character | string | Only assets generated for this character. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 120,
"description": "Words, and/or facets origin: subject: camera: light: look: mood: orientation:"
},
"kind": {
"enum": [
"image",
"video",
"audio",
"font"
],
"type": "string",
"description": "Only images, clips, uploaded audio or fonts."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "At most this many, newest first (default 40)."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Only assets attached to this site."
},
"character": {
"type": "string",
"maxLength": 60,
"description": "Only assets generated for this character."
}
},
"additionalProperties": false
}[Free] The reusable characters on this account, each with its reference images and description.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] Timestamped comments from members and review-link guests, oldest first, and the approval round.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[Free] Media people shared from their banks for anyone's films — logos, product shots, illustrations, recorded flows — with tags, a licence and the site to credit. An image scene takes an asset's id as data.asset_id (or its url as imageUrl); a gallery takes urls. Only assets their owners switched to shared.
| Argument | Type | Description |
|---|---|---|
| q | string | A word to find in tags or the asset's brief. |
| tag | string | One tag, e.g. logo, dashboard, person. |
| kind | string | Only images, or only clips. |
| limit | integer | At most this many, newest first (default 40). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 120,
"description": "A word to find in tags or the asset's brief."
},
"tag": {
"type": "string",
"maxLength": 60,
"description": "One tag, e.g. logo, dashboard, person."
},
"kind": {
"enum": [
"image",
"video"
],
"type": "string",
"description": "Only images, or only clips."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "At most this many, newest first (default 40)."
}
},
"additionalProperties": false
}[Free] Every registered connection with its alias, kind and URL. Credentials are never returned.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] The account's formats, newest change first, with versions and the shows running each.
| Argument | Type | Description |
|---|---|---|
| site_url | string | Only this site's formats. Omitted, every format on the account. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"site_url": {
"type": "string",
"format": "uri",
"description": "Only this site's formats. Omitted, every format on the account."
}
},
"additionalProperties": false
}[Free] Members with role, sites, cap and spend this month; seats; your workspaces (send one as the X-PageToVid-Workspace header to act in it).
| Argument | Type | Description |
|---|---|---|
| site_url | string | Only members with this site. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"site_url": {
"type": "string",
"format": "uri",
"description": "Only members with this site."
}
},
"additionalProperties": false
}[Free] Every model this account can generate clips and stills with — capabilities, limits and the exact credit price — before spending anything. Omit model in a scene for the house clip; name one (data.model, or set_inset model) to choose it and pay its price. quote_cost prices a specific request.
| Argument | Type | Description |
|---|---|---|
| modality | string | Only video or only image models. |
| include_unavailable | boolean | Also list models this account cannot use now, with the reason. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"modality": {
"enum": [
"video",
"image"
],
"type": "string",
"description": "Only video or only image models."
},
"include_unavailable": {
"type": "boolean",
"description": "Also list models this account cannot use now, with the reason."
}
},
"additionalProperties": false
}[Free] Your saved motion graphics (visual "motion") and the commons, with their params. Rushie designed cards: list_motions {rushie}.
| Argument | Type | Description |
|---|---|---|
| q | string | A word in the name, brief or tags. |
| scope | string | Default all. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 120,
"description": "A word in the name, brief or tags."
},
"scope": {
"enum": [
"all",
"mine",
"commons"
],
"type": "string",
"description": "Default all."
}
},
"additionalProperties": false
}[Free] How a scene can look: 26 visuals, 817 animations, motions, transitions, fx. Check pairs before writing scenes. New: get_motion_grammar.
| Argument | Type | Description |
|---|---|---|
| rushie | string | Search: words, id or beat (+9:16/1:1). |
| for_scene | string | Narration → 5 picks. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"rushie": {
"type": "string",
"maxLength": 100,
"description": "Search: words, id or beat (+9:16/1:1)."
},
"for_scene": {
"type": "string",
"maxLength": 600,
"description": "Narration → 5 picks."
}
},
"additionalProperties": false
}[Free] The reusable objects on this account, with reference images, kind and metadata (price, brand, sku).
| Argument | Type | Description |
|---|---|---|
| q | string | A word in the name or description. |
| kind | string | Only this kind. |
| site_url | string | Scope it to one of your sites. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 120,
"description": "A word in the name or description."
},
"kind": {
"enum": [
"product",
"bag",
"watch",
"logo",
"packaging",
"place",
"vehicle",
"ui_screen",
"other"
],
"type": "string",
"description": "Only this kind."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Scope it to one of your sites."
}
},
"additionalProperties": false
}[Free] Every enum and range a film accepts (voices, languages, beds, looks, captions, motions, transitions, visuals, aspects, faces, brand kit), the models with a credit example, and the inheritance levels.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] Every storyboard edit, newest first: what changed and a revision_id. restore_revision puts the storyboard back as it was before one.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many, newest first. |
| video_id* | string | The video whose storyboard history to use. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "How many, newest first."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video whose storyboard history to use."
}
},
"additionalProperties": false
}[Free] Saved scenes, newest first: name, id, visual, aspect, whether footage is kept, the {{placeholders}} each needs as params, and tags.
| Argument | Type | Description |
|---|---|---|
| q | string | A word in the name, heading or narration. |
| tags | array | Only scenes carrying every one of these tags. |
| limit | integer | At most this many, newest first (default 40). |
| site_url | string | Scope it to one of your sites. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"q": {
"type": "string",
"maxLength": 120,
"description": "A word in the name, heading or narration."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 12,
"description": "Only scenes carrying every one of these tags."
},
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "At most this many, newest first (default 40)."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Scope it to one of your sites."
}
},
"additionalProperties": false
}[Free] Reads this account. Lists the shows on this account — or one site's — with their cadence, caps, whether each is confirmed or still held, what it spent today, and its five most recent episodes with the video each became.
| Argument | Type | Description |
|---|---|---|
| site_url | string | Only this site's shows. Omitted: every show on the account. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"site_url": {
"type": "string",
"format": "uri",
"description": "Only this site's shows. Omitted: every show on the account."
}
},
"additionalProperties": false
}[Free] Lists what the theme parameter accepts: the built-in presets, the modes, the type faces the renderer can load, and the contrast and palette rules enforced before a credit moves. Static reference data.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] Lists what create_video accepts: goals, aspect ratios, languages, voices, background music beds (9, each with a family: calm, energetic, serious, playful) and the allowed length range. Static reference data — no account access.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[Free] Reads this account. Lists videos newest first with their status and, when finished, their links. Filter by status or by a word in the page URL or title. Returns a cursor when more remain.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many to return. |
| query | string | Matches part of the source URL or the title. |
| cursor | string | The next_cursor from a previous call. Opaque — pass it back unchanged. |
| status | string | Only videos in this state. |
| created_after | string | ISO 8601 timestamp; only videos created after it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "How many to return."
},
"query": {
"type": "string",
"maxLength": 120,
"description": "Matches part of the source URL or the title."
},
"cursor": {
"type": "string",
"maxLength": 512,
"description": "The next_cursor from a previous call. Opaque — pass it back unchanged."
},
"status": {
"enum": [
"any",
"queued",
"analyzing",
"scripting",
"recording",
"voicing",
"rendering",
"held",
"done",
"error"
],
"type": "string",
"default": "any",
"description": "Only videos in this state."
},
"created_after": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp; only videos created after it."
}
},
"additionalProperties": false
}[Free] The narrator voices with measured pitch (band and median Hz) and a short sample in the chosen language where one exists (else sample_url is null). Every voice speaks every language.
| Argument | Type | Description |
|---|---|---|
| pitch | string | Only this pitch band. |
| language | string | Language of the samples. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"pitch": {
"enum": [
"low",
"mid",
"high"
],
"type": "string",
"description": "Only this pitch band."
},
"language": {
"enum": [
"en",
"fr",
"es",
"de",
"it",
"pt",
"nl",
"ar",
"hi",
"ko",
"pl",
"tr",
"sv"
],
"type": "string",
"default": "en",
"description": "Language of the samples."
}
},
"additionalProperties": false
}[Free] Runs the format's resolvers against the item (real calls, cached) and compiles the storyboard: every beat's final text, the beats dropped and why, the integrity report and where every bound value came from. Nothing is rendered. Read it before run_show confirm=true.
| Argument | Type | Description |
|---|---|---|
| item | object | The item to make the episode of: {title, summary, link, image, date}. Omitted, a sample item. |
| format_id* | string | The format_id from create_format or list_formats. |
| format_version | integer | Preview this version; omitted, the latest. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format_id"
],
"properties": {
"item": {
"type": "object",
"description": "The item to make the episode of: {title, summary, link, image, date}. Omitted, a sample item."
},
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The format_id from create_format or list_formats."
},
"format_version": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Preview this version; omitted, the latest."
}
},
"additionalProperties": false
}[Free] Frames back without a render: per aspect (16:9, 9:16, 1:1) a PNG sheet of four beats (entering, landed, hold, exit) — a deterministic LAYOUT wireframe from the DSL's geometry (exact boxes, wrapping, sizes, colours, timing; system font, no blur or shadow) — plus the problems measured on that frame.
| Argument | Type | Description |
|---|---|---|
| spec | object | The spec to preview (or template_id). |
| params | object | Param values to check it with (default: the declared defaults). |
| aspects | array | Default all three. |
| seconds | number | The scene's length (its narration slice). Default 5. |
| site_url | string | Lint against this site's brand colours. |
| template_id | string | A saved template to preview instead of a spec. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"spec": {
"type": "object",
"description": "The spec to preview (or template_id)."
},
"params": {
"type": "object",
"description": "Param values to check it with (default: the declared defaults)."
},
"aspects": {
"type": "array",
"items": {
"enum": [
"16:9",
"9:16",
"1:1"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Default all three."
},
"seconds": {
"type": "number",
"maximum": 20,
"minimum": 2,
"description": "The scene's length (its narration slice). Default 5."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Lint against this site's brand colours."
},
"template_id": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "A saved template to preview instead of a spec."
}
},
"additionalProperties": false
}[Free] What something will cost, spending nothing: one generation (kind clip or image, optional model, duration_s, resolution, role, count), or a video_id's next rerender_video (render plus every AI visual not yet made). A length between two a model makes is rounded UP, with a warning; one it cannot make is refused with what it can. plan_note says when this plan has no AI generation.
| Argument | Type | Description |
|---|---|---|
| kind | string | Price one generation of this kind. |
| role | string | A full-frame scene or a presenter in a corner (a presenter uses the cheapest resolution). |
| count | integer | How many, 1-4. |
| model | string | A model id from list_models. Omit for the house model. |
| video_id | string | Price the next rerender_video of this video. |
| duration_s | number | Clip length in seconds, within the model's range. |
| resolution | string | Clip resolution, one the model offers. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"kind": {
"enum": [
"clip",
"image"
],
"type": "string",
"description": "Price one generation of this kind."
},
"role": {
"enum": [
"scene",
"inset"
],
"type": "string",
"description": "A full-frame scene or a presenter in a corner (a presenter uses the cheapest resolution)."
},
"count": {
"type": "integer",
"maximum": 4,
"minimum": 1,
"description": "How many, 1-4."
},
"model": {
"type": "string",
"maxLength": 60,
"description": "A model id from list_models. Omit for the house model."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Price the next rerender_video of this video."
},
"duration_s": {
"type": "number",
"maximum": 60,
"minimum": 1,
"description": "Clip length in seconds, within the model's range."
},
"resolution": {
"enum": [
"480p",
"720p",
"768p",
"1080p",
"2k",
"4k"
],
"type": "string",
"description": "Clip resolution, one the model offers."
}
},
"additionalProperties": false
}[Free] Registers (or replaces) a connection by alias: the URL and, optionally, a credential kept encrypted on this account. Formats refer to the alias only, so a format never carries a secret and is safe to publish or fork. Nothing is called now.
| Argument | Type | Description |
|---|---|---|
| url* | string | The server's public http(s) address: an MCP endpoint (streamable HTTP) or an http API base. |
| kind | string | mcp: JSON-RPC tools/call. http: plain JSON endpoints under this base. |
| note | string | What this server is, for the list. |
| alias* | string | The name a format's resolvers use: {"mcp": "finance_ds", ...}. Letters, digits, underscore. |
| secret | string | A bearer token or API key sent as Authorization: Bearer. Stored encrypted, never returned, never in a format. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"alias",
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The server's public http(s) address: an MCP endpoint (streamable HTTP) or an http API base."
},
"kind": {
"enum": [
"mcp",
"http"
],
"type": "string",
"default": "mcp",
"description": "mcp: JSON-RPC tools/call. http: plain JSON endpoints under this base."
},
"note": {
"type": "string",
"maxLength": 200,
"description": "What this server is, for the list."
},
"alias": {
"type": "string",
"maxLength": 40,
"minLength": 2,
"description": "The name a format's resolvers use: {\"mcp\": \"finance_ds\", ...}. Letters, digits, underscore."
},
"secret": {
"type": "string",
"maxLength": 4000,
"description": "A bearer token or API key sent as Authorization: Bearer. Stored encrypted, never returned, never in a format."
}
},
"additionalProperties": false
}[Free] Publishes a video its quality_gate held (status "held") as it is: status becomes done. Nothing is re-rendered.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The held video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The held video."
}
},
"additionalProperties": false
}[Free] Removes a member or cancels an invite, freeing the seat; your own member id leaves the workspace. Their work stays.
| Argument | Type | Description |
|---|---|---|
| member_id* | string | From list_members. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"member_id"
],
"properties": {
"member_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "From list_members."
}
},
"additionalProperties": false
}[Free] Opens an approval round for the named approvers; supersedes a pending one.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video's id. |
| approver_ids* | array | Member ids, or the owner's user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"approver_ids"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
},
"approver_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Member ids, or the owner's user id."
}
},
"additionalProperties": false
}[Free] Closes the pending round as changes requested.
| Argument | Type | Description |
|---|---|---|
| comment* | string | What to change. |
| video_id* | string | The video's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"comment"
],
"properties": {
"comment": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "What to change."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video's id."
}
},
"additionalProperties": false
}[40 credits] [free: captions_only once per paid render; a missed length target once] A new film from the video's current storyboard, without re-planning, plus any AI visual not yet made (quote_cost prices it). Free once per video when the film missed its length target (length_within_tolerance: false). The file is replaced when the new render finishes. Returns a start receipt; call get_video for the full status.
| Argument | Type | Description |
|---|---|---|
| draft | boolean | As create_video; only before the first paid render. |
| theme | object | As create_video; replaces the video's theme and is kept for later re-renders. |
| dry_run | boolean | Quote only; nothing made or charged. |
| outputs | array | As create_video; must include this video's shape. Other shapes re-render their sibling or make one, a render each. |
| video_id* | string | The video to re-render. |
| max_credits | integer | Refuse (budget_exceeded + quote) above this. |
| callback_url | string | As create_video, for this render. |
| quality_gate |
[Free] Puts the storyboard back as it was before a revision, undoing that edit and every later one. Itself a revision, so it can be undone. Nothing is re-rendered until rerender_video.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video whose storyboard history to use. |
| revision_id* | string | From list_revisions. The storyboard returns to how it was BEFORE this edit. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"revision_id"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video whose storyboard history to use."
},
"revision_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "From list_revisions. The storyboard returns to how it was BEFORE this edit."
}
},
"additionalProperties": false
}[Free] Replaces the secret completion events are signed with and returns the new one, once. The old secret stops verifying at once, including for retries still in flight.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {},
"additionalProperties": false
}[40 credits] Per episode started. Reads the show's feed (or the items given), skips items already made, and — within max_episodes_per_run and max_credits_per_day — starts one video per new item. Without confirm: the list, nothing spent. On a held show, confirm=true is the owner's one-time approval: it makes the episodes and lets the scheduler run the show from then on.
| Argument | Type | Description |
|---|---|---|
| items | array | The items to make episodes from, for a manual show. A feed show ignores this and reads its feed. |
| confirm | boolean | false (the default): a free preview of the episodes this run would make. true: make them, and on a held show, confirm it — from then on the scheduler runs it at its cadence. |
| show_id* | string | The show_id from create_show or list_shows. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"show_id"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"title"
],
"properties": {
"key": {
"type": "string",
"description": "Stable id of the item; the same key is never made twice. Defaults to the link."
},
"date": {
"type": "string",
"description": "ISO 8601."
},
"link": {
"type": "string",
"description": "The item's page, http(s). Required for a video show — it is the page that gets filmed."
},
"image": {
"type": "string",
"description": "An image URL for {{image}}."
},
"title": {
"type": "string",
"maxLength": 200
},
"summary": {
"type": "string",
"maxLength": 600
}
}
},
"maxItems": 50,
"description": "The items to make episodes from, for a manual show. A feed show ignores this and reads its feed."
},
"confirm": {
"type": "boolean",
"default": false,
"description": "false (the default): a free preview of the episodes this run would make. true: make them, and on a held show, confirm it — from then on the scheduler runs it at its cadence."
},
"show_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The show_id from create_show or list_shows."
}
},
"additionalProperties": false
}[Free] Saves a spec you wrote as a private template once it passes validate_motion_spec (repairs applied). Returns its id, params schema and the scene JSON that uses it: visual "motion", data {motion:{specId, params}}.
| Argument | Type | Description |
|---|---|---|
| name | string | Default: the spec's name. |
| spec* | object | A motion spec (get_motion_grammar). |
| tags | array | Labels to find it by. |
| params | object | Param values to check it with (default: the declared defaults). |
| site_url | string | Lint against this site's brand colours. |
| visibility | string | Default private; commons is owner/admin only. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"spec"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Default: the spec's name."
},
"spec": {
"type": "object",
"description": "A motion spec (get_motion_grammar)."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 12,
"description": "Labels to find it by."
},
"params": {
"type": "object",
"description": "Param values to check it with (default: the declared defaults)."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Lint against this site's brand colours."
},
"visibility": {
"enum": [
"private",
"commons"
],
"type": "string",
"description": "Default private; commons is owner/admin only."
}
},
"additionalProperties": false
}[Free] Saves a scene for reuse: narration, visual, data, style AND its footage and generated media (a copy). Reusing it — update_storyboard add_scene_from_library, create_animation from_library — films and generates nothing, so no AI credit. Write {{placeholders}} in its narration or data first to fill them per use.
| Argument | Type | Description |
|---|---|---|
| name* | string | A name to reuse it by. The same name replaces the earlier entry. |
| tags | array | Tags to find it by. |
| scene_id* | string | The scene, from get_storyboard. |
| video_id* | string | The video the scene is in. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"scene_id",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "A name to reuse it by. The same name replaces the earlier entry."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 12,
"description": "Tags to find it by."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene, from get_storyboard."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video the scene is in."
}
},
"additionalProperties": false
}[Free] Partial update of the options every film starts from (below a site's brand kit). null clears a field.
| Argument | Type | Description |
|---|---|---|
| look | string | Default look. |
| intro | string | Intro card template. |
| model | string | Clip model for ai_mode rich (list_models). |
| music | string | Default bed, or "asset:<id>". |
| voice | string | Default narrator. |
| end_screen | string | Outro card template. |
| transition | string | Default arrival for scenes naming none. |
| font_family | string | A list_options face. |
| caption_style | string | Default caption style. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech"
],
"type": "string",
"description": "Default look."
},
"intro": {
"enum": [
"card",
"none"
],
"type": "string",
"description": "Intro card template."
},
"model": {
"type": "string",
"maxLength": 60,
"description": "Clip model for ai_mode rich (list_models)."
},
"music": {
"type": "string",
"anyOf": [
{
"enum": [
"none",
"uplift",
"corporate",
"chill",
"cinematic",
"ambient",
"pulse",
"playful",
"warm"
]
},
{
"pattern": "^asset:[A-Za-z0-9_-]{1,64}$"
}
],
"description": "Default bed, or \"asset:<id>\"."
},
"voice": {
"enum": [
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"description": "Default narrator."
},
"end_screen": {
"enum": [
"cta",
"qr",
"social",
"logo",
"none"
],
"type": "string",
"description": "Outro card template."
},
"transition": {
"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"
],
"type": "string",
"description": "Default arrival for scenes naming none."
},
"font_family": {
"type": "string",
"maxLength": 48,
"description": "A list_options face."
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "Default caption style."
}
},
"additionalProperties": false
}[Free] Partial update of a site's brand kit: logo, palette, face (named or an uploaded font), intro/outro templates, watermark and logo corner, default voice/music/captions/look/transition. null clears a field. Films of the site inherit it unless the call overrides.
| Argument | Type | Description |
|---|---|---|
| look | string | Default look. |
| intro | string | Intro card template. |
| model | string | Clip model for ai_mode rich (list_models). |
| music | string | Default bed, or "asset:<id>". |
| voice | string | Default narrator. |
| colors | object | null | Hex per slot; partial merges. |
| site_url* | string | Any URL of the site. |
| watermark | boolean | Paid plans: badge on or off. Free keeps it. |
| end_screen | string | Outro card template. |
| transition | string | Default arrival for scenes naming none. |
[Free] Sets (or with null clears) the account-wide URL that receives a signed JSON event whenever a render ends. The first time a secret is needed it is created and returned here, once.
| Argument | Type | Description |
|---|---|---|
| url* | string | null | Public https URL for the completion event of every render that has no callback_url of its own; null removes it. Signed as callback_url describes on create_video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": [
"string",
"null"
],
"maxLength": 2000,
"description": "Public https URL for the completion event of every render that has no callback_url of its own; null removes it. Signed as callback_url describes on create_video."
}
},
"additionalProperties": false
}[40 credits] per language: a NEW video from an existing one — same storyboard and pictures, narration translated, re-voiced and re-captioned, card text (rushie cards too) translated. Filmed scenes are re-recorded on the site's page in that language when it has one (hreflang), else the footage is reused and `scenes` says so. Charged and refunded like any render; AI visuals already made are reused free.
| Argument | Type | Description |
|---|---|---|
| video_id* | string | A finished video. |
| languages* | array | One new video each. |
| idempotency_key | string | Same key within 24 h returns the videos already started, uncharged. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"languages"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "A finished video."
},
"languages": {
"type": "array",
"items": {
"enum": [
"en",
"fr",
"es",
"de",
"it",
"pt",
"nl",
"ar",
"hi",
"ko",
"pl",
"tr",
"sv"
],
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "One new video each.",
"uniqueItems": true
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 8,
"description": "Same key within 24 h returns the videos already started, uncharged."
}
},
"additionalProperties": false
}[Free] Changes a character's references, description or name; anything not given is kept. Clips already made keep the look they were made with.
| Argument | Type | Description |
|---|---|---|
| name* | string | The character's current name. |
| refs | array | 1-3 reference image URLs from your bank, replacing the current ones. |
| new_name | string | Rename it. Scenes that name the old name must be updated. |
| description | string | null | What the character looks like; null clears it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The character's current name."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "1-3 reference image URLs from your bank, replacing the current ones."
},
"new_name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Rename it. Scenes that name the old name must be updated."
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 300,
"description": "What the character looks like; null clears it."
}
},
"additionalProperties": false
}[Free] Changes any of a format's template fields. The result is a NEW version — the previous ones stay exactly as they were, and every episode already made keeps the version that made it. Shows following latest use the new version from their next run; pinned shows do not move until update_show moves them. Validated whole before anything is written.
| Argument | Type | Description |
|---|---|---|
| goal | string | As create_format. |
| name | string | A new name. |
| note | string | What this version changes, for the version history. |
| tone | string | As create_format. |
| intro | boolean | As create_format. |
| music | string | As create_format. |
| outro | boolean | As create_format. |
| theme | object | As create_video. |
| voice | string | As create_format. |
| scenes | array | animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string. |
[Free] Changes only the fields sent. Only the owner grants or changes admin and billing.
| Argument | Type | Description |
|---|---|---|
| role | string | New role. |
| member_id* | string | From list_members. |
| site_urls | array | null | Limit to these sites; null = all. |
| credit_cap | integer | null | Monthly credit cap; null = none. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"member_id"
],
"properties": {
"role": {
"enum": [
"admin",
"editor",
"reviewer",
"viewer",
"billing"
],
"type": "string",
"description": "New role."
},
"member_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "From list_members."
},
"site_urls": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "uri"
},
"maxItems": 50,
"description": "Limit to these sites; null = all."
},
"credit_cap": {
"type": [
"integer",
"null"
],
"minimum": 0,
"description": "Monthly credit cap; null = none."
}
},
"additionalProperties": false
}[Free] Renames, retags, sets param defaults or visibility, or replaces the spec of a template you wrote. Films already using it keep their picture.
| Argument | Type | Description |
|---|---|---|
| name | string | Rename it. |
| spec | object | A new spec for a template you wrote (save_motion_spec); checked like validate_motion_spec. |
| tags | array | Labels to find it by. |
| defaults | object | New default values for its params, by name. |
| visibility | string | commons shares it with every account (owner/admin only). |
| template_id* | string | The template's id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"template_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Rename it."
},
"spec": {
"type": "object",
"description": "A new spec for a template you wrote (save_motion_spec); checked like validate_motion_spec."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"maxItems": 12,
"description": "Labels to find it by."
},
"defaults": {
"type": "object",
"description": "New default values for its params, by name."
},
"visibility": {
"enum": [
"private",
"commons"
],
"type": "string",
"description": "commons shares it with every account (owner/admin only)."
},
"template_id": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The template's id."
}
},
"additionalProperties": false
}[Free] Changes only the fields sent. Media already generated with it is kept until a scene's description changes.
| Argument | Type | Description |
|---|---|---|
| kind | string | What it is. |
| name* | string | The object to change. |
| refs | array | Replace the references. |
| metadata | object | Merged into the metadata; a null value clears that key. |
| new_name | string | Rename it. |
| site_url | string | Scope it to one of your sites. |
| source_url | string | Where it comes from (a product page). Attribution only. |
| description | string | null | One line added to every prompt that names it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"kind": {
"enum": [
"product",
"bag",
"watch",
"logo",
"packaging",
"place",
"vehicle",
"ui_screen",
"other"
],
"type": "string",
"description": "What it is."
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "The object to change."
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 6,
"minItems": 1,
"description": "Replace the references."
},
"metadata": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"url": {
"type": "string"
},
"brand": {
"type": "string"
},
"price": {
"type": [
"number",
"string"
]
},
"currency": {
"type": "string"
}
},
"description": "Merged into the metadata; a null value clears that key.",
"additionalProperties": false
},
"new_name": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Rename 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."
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 300,
"description": "One line added to every prompt that names it."
}
},
"additionalProperties": false
}[Free] Changes a show's switch, cadence, caps or name, or moves it to another format or format version. The template itself is edited with update_format, which writes a new version and leaves every episode already made where it is. Nothing is rendered.
| Argument | Type | Description |
|---|---|---|
| name | string | A new name. |
| active | boolean | false pauses the show (the scheduler skips it, run_show refuses); true resumes it. |
| source | object | query shows: a new source (same shape as create_show). |
| cadence | string | A new cadence. |
| show_id* | string | The show_id from create_show or list_shows. |
| format_id | string | Move the show to another format of the same kind. |
| watchlist | array | watchlist shows: the new list; it replaces the old one. Items already made stay made. |
| repeat_every | string | query and watchlist shows: a new period, or none to stop repeating. |
| format_version | integer | Pin the show to this version of its format. |
[Free] Edits a video's storyboard in 22 operations, each described on its branch: words, captions, visuals (incl. "rushie" designed cards: data.rushie {template, props}), data, shots, scenes, transitions, fx, presenter, voice, music, look. Does not re-render — rerender_video makes the new film. Every call is snapshotted, so an edit can be undone (list_revisions).
| Argument | Type | Description |
|---|---|---|
| video_id* | string | The video to edit. Its scene ids come from get_storyboard. |
| operations* | array | The changes, in order, up to 20; all are validated before any is written, so a bad batch changes nothing. A wrong figure is set_data plus one rerender_video, not a new video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id",
"operations"
],
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video to edit. Its scene ids come from get_storyboard."
},
"operations": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "rewrite_narration",
"required": [
"op",
"scene_id",
"narration"
],
"properties": {
"op": {
"const": "rewrite_narration"
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to rewrite. Id from get_storyboard."
},
"narration": {
"type": "string",
"maxLength": 600,
"description": "The new words; [pause 500ms] = silence. Empty: a silent scene (trim_scene sets its hold)."
}
},
"description": "Replace what a scene says. The film is as long as its voiceover, so this changes the length.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_caption",
"required": [
"op",
"scene_id",
"caption"
],
"properties": {
"op": {
"const": "set_caption"
},
"caption": {
"type": [
"string",
"null"
],
"maxLength": 120,
"description": "The new caption, or null to remove it."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to caption. Id from get_storyboard."
}
},
"description": "Set or clear the on-screen caption of a scene.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_heading",
"required": [
"op",
"scene_id",
"heading"
],
"properties": {
"op": {
"const": "set_heading"
},
"heading": {
"type": "string",
"maxLength": 90,
"minLength": 1,
"description": "The new heading, as get_storyboard reports it."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to rename. Id from get_storyboard."
}
},
"description": "Rename a scene (the editor's label, never shown in the film).",
"additionalProperties": false
},
{
"type": "object",
"title": "trim_scene",
"required": [
"op",
"scene_id",
"duration_seconds"
],
"properties": {
"op": {
"const": "trim_scene"
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to trim. Id from get_storyboard."
},
"duration_seconds": {
"type": "number",
"maximum": 30,
"minimum": 2.5,
"description": "Seconds held; list_motions gives each animation's minimum."
}
},
"description": "How long a SILENT scene holds; a narrated one is refused (narrated_scene).",
"additionalProperties": false
},
{
"type": "object",
"title": "set_mood",
"required": [
"op",
"scene_id",
"mood"
],
"properties": {
"op": {
"const": "set_mood"
},
"mood": {
"enum": [
"problem",
"win",
"neutral"
],
"type": "string",
"description": "\"problem\" for a hook, \"win\" for a payoff, \"neutral\" clears it."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to tint. Id from get_storyboard."
}
},
"description": "Tint a scene: problem = red vignette and shake, win = warm glow.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_shot",
"required": [
"op",
"scene_id",
"selector"
],
"properties": {
"op": {
"const": "set_shot"
},
"text": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "For action type: a real query a visitor would type, never personal data."
},
"action": {
"enum": [
"click",
"type",
"hover",
"spotlight",
"hero",
"scroll"
],
"type": "string",
"description": "click: pressed, the page answers (most persuasive). type: types `text`, never Enter. hover, spotlight (frames it), hero (its section), scroll."
},
"page_url": {
"type": "string",
"format": "uri",
"description": "Another page of the SAME site. Omitted: the video's own page."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to re-film; a drawn scene becomes a recording. Id from get_storyboard."
},
"selector": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "An inspect_page candidate's selector, byte for byte. Matching nothing is refused with the nearest real ones."
}
},
"description": "URL videos only: a screen recording of one element, optionally on another page of the site. The best shot acts — click the call to action, or type a real query. The selector is checked live; if several match, the first is filmed (the result says so).",
"additionalProperties": false
},
{
"type": "object",
"title": "remove_scene",
"required": [
"op",
"scene_id"
],
"properties": {
"op": {
"const": "remove_scene"
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to delete. Id from get_storyboard."
}
},
"description": "Delete a scene. A storyboard must keep at least one.",
"additionalProperties": false
},
{
"type": "object",
"title": "add_scene",
"required": [
"op",
"heading",
"narration"
],
"properties": {
"op": {
"const": "add_scene"
},
"data": {
"type": "object",
"description": "The visual's payload; list_motions names the fields each visual needs."
},
"mood": {
"enum": [
"problem",
"win",
"neutral"
],
"type": "string",
"description": "As set_mood's mood."
},
"motion": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "The entrance animation, from the visual's family (list_motions)."
},
"visual": {
"type": "string",
"description": "As set_visual's visual. Omitted: a recording of the page."
},
"caption": {
"type": [
"string",
"null"
],
"maxLength": 120,
"description": "The lower-third text drawn over the scene."
},
"heading": {
"type": "string",
"maxLength": 90,
"minLength": 1,
"description": "The editor's label for the new scene."
},
"page_url": {
"type": "string",
"format": "uri",
"description": "As set_shot's page_url. Needs selector."
},
"selector": {
"type": "string",
"maxLength": 300,
"minLength": 1,
"description": "For a recorded scene (no visual): aim the camera now, as set_shot's selector."
},
"narration": {
"type": "string",
"maxLength": 600,
"description": "What the voice says; it sets the length. Empty: silent, held for duration_seconds."
},
"shot_text": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "As set_shot's text, for shot_action type."
},
"shot_action": {
"enum": [
"click",
"type",
"hover",
"spotlight",
"hero",
"scroll"
],
"type": "string",
"description": "As set_shot's action. Needs selector."
},
"after_scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Insert after this scene. No anchor: append."
},
"before_scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Insert before this scene (how to insert first)."
},
"duration_seconds": {
"type": "number",
"maximum": 30,
"minimum": 2.5,
"description": "How long a SILENT scene holds."
}
},
"description": "Insert a scene. A visual needs its fields in `data` (list_motions). Without one it records the video's page (URL videos only), aimed with selector.",
"additionalProperties": false
},
{
"type": "object",
"title": "duplicate_scene",
"required": [
"op",
"scene_id"
],
"properties": {
"op": {
"const": "duplicate_scene"
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to copy. Id from get_storyboard."
}
},
"description": "Copy a scene after itself, media included (nothing re-made).",
"additionalProperties": false
},
{
"type": "object",
"title": "add_scene_from_library",
"required": [
"op",
"scene"
],
"properties": {
"op": {
"const": "add_scene_from_library"
},
"scene": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The library scene's name or id, from list_scenes."
},
"params": {
"type": "object",
"description": "Values for its {{placeholders}}, e.g. {\"price\": \"49 €\"}; fill every one."
},
"after_scene_id": {
"type": "string",
"description": "As add_scene."
},
"before_scene_id": {
"type": "string",
"description": "As add_scene."
}
},
"description": "Insert a saved scene (list_scenes) with its media, no AI cost; params fills its {{placeholders}}.",
"additionalProperties": false
},
{
"type": "object",
"title": "reorder_scenes",
"required": [
"op",
"scene_ids"
],
"properties": {
"op": {
"const": "reorder_scenes"
},
"scene_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"description": "Every scene id of the video, in the order you want them."
}
},
"description": "Put the scenes in a new order, listing each exactly once.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_visual",
"required": [
"op",
"scene_id",
"visual"
],
"properties": {
"op": {
"const": "set_visual"
},
"data": {
"type": "object",
"description": "The visual's payload — the same shape get_storyboard returns. Omit it to keep what the scene already carries."
},
"visual": {
"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"
],
"type": "string",
"description": "The visual to draw it as."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to redraw. Id from get_storyboard."
}
},
"description": "Change how a scene is drawn. Its content is carried over unless you send new data.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_transition",
"required": [
"op",
"scene_id",
"transition"
],
"properties": {
"op": {
"const": "set_transition"
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to change the arrival of. Id from get_storyboard."
},
"transition": {
"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"
],
"type": "string",
"description": "\"cut\" is a hard cut, no effect — the right answer more often than not."
},
"duration_ms": {
"type": "integer",
"maximum": 900,
"minimum": 60,
"description": "How long the arrival takes; capped at a third of the scene."
}
},
"description": "How a DRAWN scene arrives (set_motion animates its contents); never changes the length. list_motions describes each.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_style",
"required": [
"op",
"scene_id",
"style"
],
"properties": {
"op": {
"const": "set_style"
},
"style": {
"type": "object",
"description": "As create_animation's scene style, minus transition."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to restyle. Id from get_storyboard."
}
},
"description": "A drawn scene's face and colours: replaces its style ({} = the film's).",
"additionalProperties": false
},
{
"type": "object",
"title": "set_motion",
"required": [
"op",
"scene_id",
"motion"
],
"properties": {
"fx": {
"type": "string",
"maxLength": 20,
"description": "list_motions.fx; none clears."
},
"op": {
"const": "set_motion"
},
"motion": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "From list_motions, in the visual's family."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to re-animate. Id from get_storyboard."
}
},
"description": "Change a scene's entrance animation (and fx); the wrong family is refused.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_inset",
"required": [
"op",
"scene_id",
"generate"
],
"properties": {
"op": {
"const": "set_inset"
},
"mute": {
"type": "boolean",
"description": "The face without the voice (default: heard only on a silent scene)."
},
"seed": {
"type": "integer",
"description": "As generate_asset."
},
"shot": {
"enum": [
"wide",
"medium",
"close_up"
],
"type": "string",
"description": "As generate_asset."
},
"size": {
"type": "number",
"maximum": 0.42,
"minimum": 0.14,
"description": "Width as a share of the frame; clamped, never refused."
},
"model": {
"type": "string",
"maxLength": 60,
"description": "As generate_asset's model (auto, a list_models id, omit: house)."
},
"shape": {
"enum": [
"rounded",
"circle",
"square"
],
"type": "string",
"description": "rounded keeps the clip; circle crops to a head (needs a close-up)."
},
"camera": {
"type": "object",
"description": "As generate_asset."
},
"corner": {
"enum": [
"bottom-right",
"bottom-left",
"top-right",
"top-left"
],
"type": "string",
"description": "Omitted: the corner clear of the subject. Named: honoured, even over it."
},
"best_of": {
"type": "integer",
"description": "As generate_asset."
},
"objects": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 8,
"description": "Object names (list_objects) the presenter shows, kept consistent."
},
"generate": {
"type": [
"string",
"null"
],
"maxLength": 600,
"minLength": 3,
"description": "The shot, e.g. \"a woman at a desk, talking to camera\"; a quoted line is said aloud."
},
"optimize": {
"enum": [
"quality",
"balanced",
"speed",
"cost"
],
"type": "string",
"description": "As generate_asset."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to put a presenter on. Id from get_storyboard."
},
"character": {
"type": "string",
"maxLength": 60,
"description": "A create_character name, so the same face recurs."
},
"duration_s": {
"type": "integer",
"description": "As generate_asset."
},
"last_frame": {
"type": "string",
"description": "As generate_asset."
},
"resolution": {
"enum": [
"480p",
"720p",
"768p",
"1080p",
"2k",
"4k"
],
"type": "string",
"description": "As generate_asset."
},
"first_frame": {
"type": "string",
"description": "As generate_asset."
},
"negative_prompt": {
"type": "string",
"description": "As generate_asset."
}
},
"description": "A presenter in the corner: a generated clip of a person OVER this scene. Paid plans; one clip, refunded if it fails. generate: null removes it.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_data",
"required": [
"op",
"scene_id",
"data"
],
"properties": {
"op": {
"const": "set_data"
},
"data": {
"type": "object",
"description": "The visual's payload, as get_storyboard returns it."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to correct. Id from get_storyboard."
}
},
"description": "Correct a scene's content, keeping visual and motion. Send the WHOLE payload (it replaces): get_storyboard's `data`, fixed.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_voice",
"required": [
"op",
"voice"
],
"properties": {
"op": {
"const": "set_voice"
},
"voice": {
"enum": [
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"description": "The whole video's narrator (set_scene_voice for one scene)."
}
},
"description": "Change the narrator for the whole video.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_scene_voice",
"required": [
"op",
"scene_id"
],
"properties": {
"op": {
"const": "set_scene_voice"
},
"speed": {
"type": "number",
"maximum": 1.2,
"minimum": 0.8,
"description": "Its pace, the pitch kept."
},
"voice": {
"type": "string",
"description": "As set_voice."
},
"emotion": {
"enum": [
"neutral",
"warm",
"excited",
"serious",
"calm"
],
"type": "string",
"description": "Its register; neutral = the film's."
},
"scene_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The scene to direct. Id from get_storyboard."
}
},
"description": "One scene's own narrator, pace or register; none of the three restores the film's.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_pronunciations",
"required": [
"op",
"pronunciations"
],
"properties": {
"op": {
"const": "set_pronunciations"
},
"pronunciations": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"say"
],
"properties": {
"say": {
"type": "string"
},
"text": {
"type": "string"
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "e.g. [{\"text\":\"Nginx\",\"say\":\"engine x\"}]"
}
},
"description": "Replace the voice's lexicon (captions keep the text); [] clears it.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_music",
"required": [
"op",
"music"
],
"properties": {
"op": {
"const": "set_music"
},
"music": {
"type": "string",
"anyOf": [
{
"enum": [
"none",
"uplift",
"corporate",
"chill",
"cinematic",
"ambient",
"pulse",
"playful",
"warm"
]
},
{
"pattern": "^asset:[A-Za-z0-9_-]{1,64}$"
}
],
"description": "The bed under the whole video, or \"asset:<id>\" from upload_asset."
}
},
"description": "Change the background music for the whole video.",
"additionalProperties": false
},
{
"type": "object",
"title": "set_look",
"required": [
"op",
"look"
],
"properties": {
"op": {
"const": "set_look"
},
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech"
],
"type": "string",
"description": "As create_video, without auto."
},
"edit_style": {
"enum": [
"tiktok_punchy",
"documentary",
"corporate",
"cinematic"
],
"type": "string",
"description": "As create_video."
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "As create_video."
}
},
"description": "Change the film's LOOK (captions, cutting, sound cues, motion) from the next render; timing never moves.",
"additionalProperties": false
}
]
},
"maxItems": 20,
"minItems": 1,
"description": "The changes, in order, up to 20; all are validated before any is written, so a bad batch changes nothing. A wrong figure is set_data plus one rerender_video, not a new video."
}
},
"additionalProperties": false
}[Free] Puts a file in your bank from a public https url or small data_base64 (a bigger file you hold: create_upload). Picture or clip → data.asset_id in an image scene; audio → music "asset:<id>"; deck (PDF/PPTX) → every slide's text and pictures, to write the storyboard from. Identical bytes return the existing asset.
| Argument | Type | Description |
|---|---|---|
| url | string | Public https URL. |
| kind | string | Required with url. image ≤ 20 MB, video ≤ 200 MB/60 s, audio ≤ 50 MB, font ≤ 2 MB, deck (PDF/PPTX) ≤ 30 MB. |
| name | string | A label to find it again. |
| filename | string | Its file name. |
| site_url | string | Attach an image or clip to one of your sites. |
| data_base64 | string | The file, base64, ≤ 2 MB. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public https URL."
},
"kind": {
"enum": [
"image",
"video",
"audio",
"font",
"deck"
],
"type": "string",
"description": "Required with url. image ≤ 20 MB, video ≤ 200 MB/60 s, audio ≤ 50 MB, font ≤ 2 MB, deck (PDF/PPTX) ≤ 30 MB."
},
"name": {
"type": "string",
"maxLength": 200,
"description": "A label to find it again."
},
"filename": {
"type": "string",
"maxLength": 200,
"description": "Its file name."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Attach an image or clip to one of your sites."
},
"data_base64": {
"type": "string",
"maxLength": 4194304,
"minLength": 8,
"description": "The file, base64, ≤ 2 MB."
}
},
"additionalProperties": false
}[Free] Compiles the template against a sample item, touching no database or feed: the catalogue checks (voice, music, language, theme…), the scene templates filled and checked as an animation, and what the first episode's title, brief and scene count would be. Returns problems by field; nothing is created, rendered or charged.
| Argument | Type | Description |
|---|---|---|
| goal | string | As create_format. |
| kind | string | video or animation. |
| name | string | The format's name, for {{show}}. |
| tone | string | As create_format. |
| intro | boolean | As create_format. |
| music | string | As create_format. |
| outro | boolean | As create_format. |
| theme | object | As create_video. |
| voice | string | As create_format. |
| scenes |
[Free] Dry-run a spec: deterministic repairs, schema, params, layout/legibility/contrast/timing on four frames and the motion doctrine. Returns ok, every problem with its path and fix, the repaired spec and the params schema. Nothing is saved.
| Argument | Type | Description |
|---|---|---|
| spec* | object | A motion spec (get_motion_grammar). |
| params | object | Param values to check it with (default: the declared defaults). |
| site_url | string | Lint against this site's brand colours. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"spec"
],
"properties": {
"spec": {
"type": "object",
"description": "A motion spec (get_motion_grammar)."
},
"params": {
"type": "object",
"description": "Param values to check it with (default: the declared defaults)."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Lint against this site's brand colours."
}
},
"additionalProperties": false
}[Free] The proof behind a film: the format version that made it (template SHA-256), every resolver source and what it fetched, the integrity report, the claim ledger (which figures trace to the page, the brief or nothing), the Content Credentials (C2PA), and a check recompiling the stored data against the narration word for word.
| Argument | Type | Description |
|---|---|---|
| video_id | string | Or a video id: the episode is found through it when there is one; a plain video is verified on its claim ledger and credentials. |
| episode_id | string | The episode to verify, from run_show or a show's recent_episodes. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Or a video id: the episode is found through it when there is one; a plain video is verified on its claim ledger and credentials."
},
"episode_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The episode to verify, from run_show or a show's recent_episodes."
}
},
"additionalProperties": false
}| title |
| string |
| Name for the video. Defaults to the first scene's heading. |
| voice | string | As create_video. |
| scenes* | array | 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. |
| ai_mode | string | As create_video. Server picks scenes and prompts; omitted: data.generate only. |
| callout | string | As create_video. |
| dry_run | boolean | Quote only; nothing made or charged. |
| objects | array | With ai_mode: in every added shot. |
| outputs | array | As create_video. |
| cta_text | string | Call to action on the closing card. |
| language | string | As create_video. Write the narration in it. |
| ai_budget | object | A ceiling on this render's AI generation; the receipt's ai_plan says what was asked for and its cost. Omitted: uncapped. |
| character | string | With ai_mode: in every added shot. |
| sfx_level | string | As create_video. |
| subtitles | boolean | As create_video. |
| brand_name | string | Name shown on the intro and outro cards. |
| edit_style | string | As create_video. |
| end_screen | string | As create_video. |
| source_url | string | Attribution only; nothing is fetched or filmed. |
| max_credits | integer | Refuse (budget_exceeded + quote) above this. |
| aspect_ratio | string | 16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds. |
| callback_url | string | As create_video. |
| cursor_style | string | As create_video. |
| press_effect | string | As create_video. |
| caption_style | string | As create_video. |
| pronunciations | array | As create_video. |
| target_seconds | integer | 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. |
| generate_motion | boolean | As create_video. |
| idempotency_key | string | As create_video. |
| caption_emphasis | string | As create_video. |
| caption_animation | string | As create_video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"scenes"
],
"properties": {
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech",
"auto"
],
"type": "string",
"default": "auto",
"description": "As create_video."
},
"tone": {
"type": "string",
"default": "energetic",
"description": "As create_video."
},
"draft": {
"type": "boolean",
"description": "As create_video."
},
"grade": {
"enum": [
"none",
"warm",
"cool",
"vivid",
"mono",
"vintage",
"contrast"
],
"type": "string",
"description": "As create_video."
},
"intro": {
"type": "boolean",
"default": true,
"description": "Include the branded opening title card."
},
"model": {
"type": "string",
"description": "As create_video."
},
"music": {
"type": "string",
"default": "auto",
"description": "As create_video."
},
"outro": {
"type": "boolean",
"default": true,
"description": "As create_video."
},
"theme": {
"type": "object",
"description": "As create_video. Omitted: the house palette."
},
"title": {
"type": "string",
"maxLength": 90,
"description": "Name for the video. Defaults to the first scene's heading."
},
"voice": {
"type": "string",
"default": "auto",
"description": "As create_video."
},
"scenes": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"visual",
"heading"
],
"properties": {
"fx": {
"type": "string",
"description": "Accent layer (list_motions)."
},
"data": {
"type": "object",
"description": "The visual's payload; list_motions.visuals[].requires names the fields."
},
"mood": {
"enum": [
"problem",
"win",
"neutral"
],
"type": "string",
"description": "Tint: problem, win, or neutral (none)."
},
"speed": {
"type": "number",
"maximum": 1.2,
"minimum": 0.8,
"description": "Scene pace."
},
"style": {
"type": "object",
"properties": {
"font": {
"enum": [
"sans",
"serif",
"mono"
],
"type": "string"
},
"size": {
"enum": [
"sm",
"md",
"lg"
],
"type": "string",
"description": "Type scale."
},
"theme": {
"enum": [
"dark",
"light",
"brand"
],
"type": "string",
"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."
},
"transition": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"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"
],
"type": "string"
},
"duration_ms": {
"type": "number",
"maximum": 900,
"minimum": 60
}
},
"description": "How this scene arrives (list_motions)."
},
"font_family": {
"type": "string",
"description": "One of list_themes' faces."
}
},
"description": "This scene's own look, overriding the film's theme."
},
"voice": {
"enum": [
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"description": "Scene narrator."
},
"motion": {
"type": "string",
"description": "Entrance animation from the visual's family; omitted, one is chosen."
},
"visual": {
"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"
],
"type": "string",
"description": "How the scene is drawn (list_motions)."
},
"caption": {
"type": "string",
"maxLength": 120,
"description": "Lower-third caption."
},
"emotion": {
"enum": [
"neutral",
"warm",
"excited",
"serious",
"calm"
],
"type": "string",
"description": "Scene register."
},
"heading": {
"type": "string",
"maxLength": 90,
"description": "A few words naming the beat."
},
"narration": {
"type": "string",
"maxLength": 600,
"description": "Spoken over the scene; its length IS the scene's. [pause 500ms] = silence."
},
"duration_seconds": {
"type": "number",
"maximum": 30,
"minimum": 2.5,
"description": "Hold of a scene with no narration."
}
}
},
{
"type": "object",
"required": [
"from_library"
],
"properties": {
"params": {
"type": "object",
"description": "Values for its {{placeholders}}."
},
"from_library": {
"type": "string",
"description": "A saved scene's name or id (list_scenes), footage and media included — no AI cost."
}
},
"additionalProperties": false
}
]
},
"maxItems": 20,
"minItems": 1,
"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."
},
"ai_mode": {
"enum": [
"none",
"assist",
"rich"
],
"type": "string",
"description": "As create_video. Server picks scenes and prompts; omitted: data.generate only."
},
"callout": {
"enum": [
"none",
"ring",
"arrow",
"underline",
"dim"
],
"type": "string",
"description": "As create_video."
},
"dry_run": {
"type": "boolean",
"description": "Quote only; nothing made or charged."
},
"objects": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 3,
"description": "With ai_mode: in every added shot."
},
"outputs": {
"type": "array",
"description": "As create_video."
},
"cta_text": {
"type": "string",
"maxLength": 60,
"description": "Call to action on the closing card."
},
"language": {
"type": "string",
"default": "en",
"description": "As create_video. Write the narration in it."
},
"ai_budget": {
"type": "object",
"properties": {
"max_clips": {
"type": "integer",
"minimum": 0
},
"on_exceed": {
"enum": [
"refuse",
"queue",
"fallback"
],
"type": "string",
"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."
},
"max_images": {
"type": "integer",
"minimum": 0
}
},
"description": "A ceiling on this render's AI generation; the receipt's ai_plan says what was asked for and its cost. Omitted: uncapped."
},
"character": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "With ai_mode: in every added shot."
},
"sfx_level": {
"enum": [
"off",
"subtle",
"full"
],
"type": "string",
"description": "As create_video."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "As create_video."
},
"brand_name": {
"type": "string",
"maxLength": 60,
"description": "Name shown on the intro and outro cards."
},
"edit_style": {
"enum": [
"tiktok_punchy",
"documentary",
"corporate",
"cinematic"
],
"type": "string",
"description": "As create_video."
},
"end_screen": {
"enum": [
"cta",
"qr",
"social",
"logo",
"none"
],
"type": "string",
"description": "As create_video."
},
"source_url": {
"type": "string",
"format": "uri",
"description": "Attribution only; nothing is fetched or filmed."
},
"max_credits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Refuse (budget_exceeded + quote) above this."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"description": "16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds."
},
"callback_url": {
"type": "string",
"description": "As create_video."
},
"cursor_style": {
"enum": [
"arrow",
"hand",
"dot",
"none"
],
"type": "string",
"description": "As create_video."
},
"press_effect": {
"enum": [
"punch",
"freeze",
"slowmo",
"none"
],
"type": "string",
"description": "As create_video."
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "As create_video."
},
"pronunciations": {
"type": "array",
"description": "As create_video."
},
"target_seconds": {
"type": "integer",
"maximum": 180,
"minimum": 15,
"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."
},
"generate_motion": {
"type": "boolean",
"description": "As create_video."
},
"idempotency_key": {
"type": "string",
"description": "As create_video."
},
"caption_emphasis": {
"enum": [
"manual",
"auto",
"none"
],
"type": "string",
"description": "As create_video."
},
"caption_animation": {
"enum": [
"none",
"pop",
"bounce",
"wave",
"glow",
"slide"
],
"type": "string",
"description": "As create_video."
}
},
"additionalProperties": false
}| object |
| As create_video. |
| voice | string | Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films. |
| scenes | array | animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string. |
| routing | object | 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. |
| language | string | Language of the voiceover and captions. Write the narration in this language. |
| site_url* | string | Any public http(s) URL on the site the format belongs to; the site is identified by its domain. |
| programme | object | 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. |
| subtitles | boolean | Burn captions into the picture and emit a .vtt sidecar. |
| brand_name | string | Name shown on the intro and outro cards. |
| aspect_ratio | string | 16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds. |
| focus_template | string | video formats: the brief every episode's script writer gets, with {{title}} {{summary}} {{link}} {{date}} {{image}} {{show}} {{site}} filled from the item. |
| target_seconds | integer | 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_template | string | animation formats: the episode's title, same placeholders. Default "{{show}} — {{title}}". |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url",
"name"
],
"properties": {
"goal": {
"enum": [
"explainer",
"ad",
"demo",
"tutorial",
"article"
],
"type": "string",
"default": "explainer",
"description": "What the video is for; shapes the script."
},
"kind": {
"enum": [
"video",
"animation"
],
"type": "string",
"default": "video",
"description": "video: episodes film the item's page. animation: episodes are drawn from `scenes` with the item's data filled in."
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The format's name, e.g. \"Le mot du chantier\". Available as {{show}} in templates."
},
"tone": {
"type": "string",
"default": "energetic",
"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\"."
},
"intro": {
"type": "boolean",
"default": true,
"description": "Include the branded opening title card."
},
"music": {
"type": "string",
"anyOf": [
{
"enum": [
"auto",
"none",
"uplift",
"corporate",
"chill",
"cinematic",
"ambient",
"pulse",
"playful",
"warm"
]
},
{
"pattern": "^asset:[A-Za-z0-9_-]{1,64}$"
}
],
"default": "auto",
"description": "Music bed, \"none\", or \"asset:<id>\" (upload_asset). auto fits the goal and differs from the site's previous films."
},
"outro": {
"type": "boolean",
"default": true,
"description": "Include the closing call-to-action card."
},
"theme": {
"type": "object",
"description": "As create_video."
},
"voice": {
"enum": [
"auto",
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"default": "auto",
"description": "Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films."
},
"scenes": {
"type": "array",
"description": "animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string."
},
"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."
},
"language": {
"enum": [
"en",
"fr",
"es",
"de",
"it",
"pt",
"nl",
"ar",
"hi",
"ko",
"pl",
"tr",
"sv"
],
"type": "string",
"default": "en",
"description": "Language of the voiceover and captions. Write the narration in this language."
},
"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."
},
"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."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "Burn captions into the picture and emit a .vtt sidecar."
},
"brand_name": {
"type": "string",
"maxLength": 60,
"description": "Name shown on the intro and outro cards."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"description": "16:9 for web and YouTube, 9:16 for Reels/Shorts/TikTok, 1:1 and 4:5 (1080×1350) for feeds."
},
"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."
},
"target_seconds": {
"type": "integer",
"maximum": 180,
"minimum": 15,
"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_template": {
"type": "string",
"maxLength": 120,
"description": "animation formats: the episode's title, same placeholders. Default \"{{show}} — {{title}}\"."
}
},
"additionalProperties": false
}| As create_format. |
| scenes | array | As create_format. An image scene whose {{image}} is empty for an item is dropped from that episode. |
| source | object | 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. |
| cadence | string | 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. |
| routing | object | As create_format. |
| feed_map | object | 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. |
| feed_url | string | The feed's public URL for rss and json. It is read once now to make sure it parses. |
| language | string | As create_format. |
| site_url* | string | Any public http(s) URL on the site; the site is identified by its domain. |
| feed_kind | string | 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. |
| format_id | string | 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. |
| subtitles | boolean | As create_format. |
| watchlist | array | feed_kind watchlist: the items, as run_show takes them. Each is made once — or once per period with repeat_every. |
| brand_name | string | As create_format. |
| aspect_ratio | string | As create_format. |
| repeat_every | string | 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. |
| focus_template | string | As create_format. Omitted: a brief leading with the item's title and summary. |
| format_version | integer | With format_id: pin the show to this version. Omitted, the show follows the format's latest version. |
| target_seconds | integer | As create_format. |
| title_template | string | As create_format. |
| max_credits_per_day | integer | The show never spends more than this in a UTC day, however many items the feed gains. An episode is 40 credits. |
| max_episodes_per_run | integer | Newest items first; at most this many episodes per run. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url",
"name"
],
"properties": {
"goal": {
"enum": [
"explainer",
"ad",
"demo",
"tutorial",
"article"
],
"type": "string",
"default": "explainer",
"description": "As create_format."
},
"kind": {
"enum": [
"video",
"animation"
],
"type": "string",
"default": "video",
"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."
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "The show's name, e.g. \"Le mot du chantier\". Available as {{show}} in templates."
},
"tone": {
"type": "string",
"default": "energetic",
"description": "As create_format."
},
"intro": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"music": {
"type": "string",
"default": "auto",
"description": "As create_format."
},
"outro": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"theme": {
"type": "object",
"description": "As create_video."
},
"voice": {
"type": "string",
"default": "auto",
"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."
},
"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."
},
"cadence": {
"enum": [
"manual",
"hourly",
"daily",
"weekly"
],
"type": "string",
"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."
},
"routing": {
"type": "object",
"description": "As create_format."
},
"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."
},
"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."
},
"language": {
"type": "string",
"default": "en",
"description": "As create_format."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Any public http(s) URL on the site; the site is identified by its domain."
},
"feed_kind": {
"enum": [
"rss",
"json",
"manual",
"query",
"watchlist",
"webhook"
],
"type": "string",
"default": "rss",
"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."
},
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"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."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"watchlist": {
"type": "array",
"items": {
"type": "object",
"required": [
"title"
],
"properties": {
"key": {
"type": "string"
},
"date": {
"type": "string"
},
"link": {
"type": "string"
},
"image": {
"type": "string"
},
"title": {
"type": "string",
"maxLength": 200
},
"summary": {
"type": "string",
"maxLength": 600
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "feed_kind watchlist: the items, as run_show takes them. Each is made once — or once per period with repeat_every."
},
"brand_name": {
"type": "string",
"description": "As create_format."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"description": "As create_format."
},
"repeat_every": {
"enum": [
"none",
"month",
"quarter",
"year"
],
"type": "string",
"default": "none",
"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."
},
"focus_template": {
"type": "string",
"description": "As create_format. Omitted: a brief leading with the item's title and summary."
},
"format_version": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "With format_id: pin the show to this version. Omitted, the show follows the format's latest version."
},
"target_seconds": {
"type": "integer",
"description": "As create_format."
},
"title_template": {
"type": "string",
"description": "As create_format."
},
"max_credits_per_day": {
"type": "integer",
"default": 120,
"maximum": 2000,
"minimum": 40,
"description": "The show never spends more than this in a UTC day, however many items the feed gains. An episode is 40 credits."
},
"max_episodes_per_run": {
"type": "integer",
"default": 1,
"maximum": 10,
"minimum": 1,
"description": "Newest items first; at most this many episodes per run."
}
},
"additionalProperties": false
}| intro | boolean | Opening title card (1.5 s). Omitted: true, except goal "ad" (opens on its hook). |
| model | string | Clip model (list_models) for ai_mode rich, or auto (routed per scene, see optimize); omit for the house clip. |
| music | string | Music bed, "none", or "asset:<id>" (upload_asset). auto fits the goal and differs from the site's previous films. |
| outro | boolean | Closing call-to-action card. |
| theme | object | 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. |
| voice | string | Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films. |
| ai_mode | string | 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. |
| callout | string | What points at a screencast's subject. |
| dry_run | boolean | Quote only; nothing made or charged. |
| outputs | array | 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. |
| routing | object | {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. |
| language | string | Language of the script and voiceover. Omitted: the page's own language, else its country domain's (.fr, .de…), else the account's. |
| optimize | string | With model auto: quality, balanced (default), speed or cost. |
| ai_budget | object | Ceiling on AI visuals, given to the planner. |
| sfx_level | string | Sound-design loudness; overrides the look's. |
| subtitles | boolean | Burn captions in and emit a .vtt sidecar. |
| brand_name | string | Name on the intro and outro cards; default the site's. |
| edit_style | string | Cutting rhythm (list_motions); a scene's own transition still wins. |
| end_screen | string | The closing card. |
| max_credits | integer | Refuse (budget_exceeded + quote) above this. |
| aspect_ratio | string | 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. |
| callback_url | string | 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. |
| cursor_style | string | The pointer a recording draws. |
| press_effect | string | What the picture does on a click. |
| quality_gate | object | 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. |
| caption_style | string | Overrides the look's captions. |
| pronunciations | array | Voice-only lexicon, e.g. [{"text":"Nginx","say":"engine x"}]; captions keep the text. |
| target_seconds | integer | Length asked for: the words are written to fit it. |
| generate_motion | boolean | Custom motion graphics for beats no built-in visual fits (AI plans or a film pass, else built-in). |
| idempotency_key | string | Same key within 24 h returns the original video, uncharged. Without one, an identical call within 120 s returns the first video (idempotent_replay). |
| caption_emphasis | string | Brand-coloured words: **asterisked** (manual), plus figures (auto), or none. |
| caption_animation | string | What a spoken word does; overrides the look's. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public http(s) page to film; you must have the right to."
},
"goal": {
"enum": [
"explainer",
"ad",
"demo",
"tutorial",
"article"
],
"type": "string",
"default": "explainer",
"description": "What the video is for; shapes the script."
},
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech",
"auto"
],
"type": "string",
"default": "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)."
},
"tone": {
"type": "string",
"default": "energetic",
"maxLength": 80,
"description": "Narration delivery, e.g. calm, or a short direction."
},
"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."
},
"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."
},
"grade": {
"enum": [
"none",
"warm",
"cool",
"vivid",
"mono",
"vintage",
"contrast"
],
"type": "string",
"description": "Footage colour grade; overrides the look's."
},
"intro": {
"type": "boolean",
"description": "Opening title card (1.5 s). Omitted: true, except goal \"ad\" (opens on its hook)."
},
"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."
},
"music": {
"type": "string",
"anyOf": [
{
"enum": [
"auto",
"none",
"uplift",
"corporate",
"chill",
"cinematic",
"ambient",
"pulse",
"playful",
"warm"
]
},
{
"pattern": "^asset:[A-Za-z0-9_-]{1,64}$"
}
],
"default": "auto",
"description": "Music bed, \"none\", or \"asset:<id>\" (upload_asset). auto fits the goal and differs from the site's previous films."
},
"outro": {
"type": "boolean",
"default": true,
"description": "Closing call-to-action card."
},
"theme": {
"type": "object",
"properties": {
"font": {
"enum": [
"sans",
"serif",
"mono"
],
"type": "string",
"description": "Type category. Implied by font_family when you set one."
},
"mode": {
"enum": [
"dark",
"light",
"brand"
],
"type": "string",
"description": "dark (default), light, or brand (your colours fill the frame, white type)."
},
"colors": {
"type": "array",
"items": {
"type": "string",
"pattern": "^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
},
"maxItems": 2,
"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."
},
"corners": {
"enum": [
"sharp",
"soft",
"round"
],
"type": "string",
"description": "Corner language for cards, chips and bars."
},
"negative": {
"type": "string",
"description": "Hex colour washed over a scene marked mood PROBLEM. Defaults to red."
},
"positive": {
"type": "string",
"description": "Hex colour washed over a scene marked mood WIN. Defaults to your first accent."
},
"font_family": {
"type": "string",
"description": "A face from list_themes; any other is refused."
}
},
"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.",
"additionalProperties": false
},
"voice": {
"enum": [
"auto",
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"default": "auto",
"description": "Narrator (all multilingual). auto picks a voice that fits the goal and tone and differs from the site's previous films."
},
"ai_mode": {
"enum": [
"none",
"assist",
"rich"
],
"type": "string",
"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."
},
"callout": {
"enum": [
"none",
"ring",
"arrow",
"underline",
"dim"
],
"type": "string",
"description": "What points at a screencast's subject."
},
"dry_run": {
"type": "boolean",
"description": "Quote only; nothing made or charged."
},
"outputs": {
"type": "array",
"items": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"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.",
"uniqueItems": true
},
"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."
},
"language": {
"enum": [
"en",
"fr",
"es",
"de",
"it",
"pt",
"nl",
"ar",
"hi",
"ko",
"pl",
"tr",
"sv"
],
"type": "string",
"description": "Language of the script and voiceover. Omitted: the page's own language, else its country domain's (.fr, .de…), else the account's."
},
"optimize": {
"enum": [
"quality",
"balanced",
"speed",
"cost"
],
"type": "string",
"description": "With model auto: quality, balanced (default), speed or cost."
},
"ai_budget": {
"type": "object",
"properties": {
"max_clips": {
"type": "integer",
"minimum": 0
},
"on_exceed": {
"enum": [
"refuse",
"queue",
"fallback"
],
"type": "string",
"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."
},
"max_images": {
"type": "integer",
"minimum": 0
}
},
"description": "Ceiling on AI visuals, given to the planner."
},
"sfx_level": {
"enum": [
"off",
"subtle",
"full"
],
"type": "string",
"description": "Sound-design loudness; overrides the look's."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "Burn captions in and emit a .vtt sidecar."
},
"brand_name": {
"type": "string",
"maxLength": 60,
"description": "Name on the intro and outro cards; default the site's."
},
"edit_style": {
"enum": [
"tiktok_punchy",
"documentary",
"corporate",
"cinematic"
],
"type": "string",
"description": "Cutting rhythm (list_motions); a scene's own transition still wins."
},
"end_screen": {
"enum": [
"cta",
"qr",
"social",
"logo",
"none"
],
"type": "string",
"description": "The closing card."
},
"max_credits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Refuse (budget_exceeded + quote) above this."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"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."
},
"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."
},
"cursor_style": {
"enum": [
"arrow",
"hand",
"dot",
"none"
],
"type": "string",
"description": "The pointer a recording draws."
},
"press_effect": {
"enum": [
"punch",
"freeze",
"slowmo",
"none"
],
"type": "string",
"description": "What the picture does on a click."
},
"quality_gate": {
"type": "object",
"properties": {
"on_fail": {
"enum": [
"auto_fix",
"hold",
"deliver"
],
"type": "string"
},
"min_score": {
"type": "number",
"maximum": 100,
"minimum": 0
}
},
"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.",
"additionalProperties": false
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "Overrides the look's captions."
},
"pronunciations": {
"type": "array",
"items": {
"type": "object",
"required": [
"text",
"say"
],
"properties": {
"say": {
"type": "string",
"maxLength": 120
},
"text": {
"type": "string",
"maxLength": 60
}
},
"additionalProperties": false
},
"maxItems": 50,
"description": "Voice-only lexicon, e.g. [{\"text\":\"Nginx\",\"say\":\"engine x\"}]; captions keep the text."
},
"target_seconds": {
"type": "integer",
"default": 45,
"maximum": 180,
"minimum": 15,
"description": "Length asked for: the words are written to fit it."
},
"generate_motion": {
"type": "boolean",
"description": "Custom motion graphics for beats no built-in visual fits (AI plans or a film pass, else built-in)."
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 8,
"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)."
},
"caption_emphasis": {
"enum": [
"manual",
"auto",
"none"
],
"type": "string",
"description": "Brand-coloured words: **asterisked** (manual), plus figures (auto), or none."
},
"caption_animation": {
"enum": [
"none",
"pop",
"bounce",
"wave",
"glow",
"slide"
],
"type": "string",
"description": "What a spoken word does; overrides the look's."
}
},
"additionalProperties": false
}| dry_run | boolean | Quote only; nothing made or charged. |
| objects | array | Object names (list_objects) kept consistent, after the character. |
| optimize | string | For model auto. Default balanced. |
| site_url | string | Attach it to one of your sites. |
| character | string | A character from create_character, so the same face comes back. |
| duration_s | integer | Seconds (list_models range). |
| last_frame | string | Bank image to end on. |
| resolution | string | One the model offers. |
| first_frame | string | Bank image id/URL to start on. |
| max_credits | integer | Refuse (budget_exceeded + quote) above this. |
| aspect_ratio | string | Default 16:9. 21:9 and 4:5 only where list_models says the model takes them. |
| idempotency_key | string | 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. |
| negative_prompt | string | Where the model takes one. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"prompt"
],
"properties": {
"kind": {
"enum": [
"image",
"video"
],
"type": "string",
"description": "image (a still) or video (a clip). Default image."
},
"seed": {
"type": "integer",
"maximum": 4294967295,
"minimum": 0,
"description": "Where the model takes one."
},
"shot": {
"enum": [
"wide",
"medium",
"close_up"
],
"type": "string",
"description": "Folded into the prompt."
},
"tags": {
"type": "string",
"maxLength": 400,
"description": "Comma-separated tags, to find it again."
},
"count": {
"type": "integer",
"maximum": 4,
"minimum": 1,
"description": "Stills: how many, each charged."
},
"model": {
"type": "string",
"maxLength": 60,
"description": "list_models id, house, house-image, or auto (clips; see optimize)."
},
"camera": {
"type": "object",
"required": [
"move"
],
"properties": {
"move": {
"enum": [
"static",
"pan_left",
"pan_right",
"tilt_up",
"tilt_down",
"dolly_in",
"dolly_out",
"orbit",
"handheld"
],
"type": "string"
},
"speed": {
"enum": [
"slow",
"medium",
"fast"
],
"type": "string"
}
},
"description": "Folded into the prompt.",
"additionalProperties": false
},
"prompt": {
"type": "string",
"maxLength": 600,
"minLength": 3,
"description": "What to draw or film."
},
"best_of": {
"type": "integer",
"maximum": 4,
"minimum": 1,
"description": "N graded, best kept, all charged."
},
"dry_run": {
"type": "boolean",
"description": "Quote only; nothing made or charged."
},
"objects": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 8,
"description": "Object names (list_objects) kept consistent, after the character."
},
"optimize": {
"enum": [
"quality",
"balanced",
"speed",
"cost"
],
"type": "string",
"description": "For model auto. Default balanced."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Attach it to one of your sites."
},
"character": {
"type": "string",
"maxLength": 60,
"description": "A character from create_character, so the same face comes back."
},
"duration_s": {
"type": "integer",
"maximum": 60,
"minimum": 1,
"description": "Seconds (list_models range)."
},
"last_frame": {
"type": "string",
"maxLength": 600,
"minLength": 1,
"description": "Bank image to end on."
},
"resolution": {
"enum": [
"480p",
"720p",
"768p",
"1080p",
"2k",
"4k"
],
"type": "string",
"description": "One the model offers."
},
"first_frame": {
"type": "string",
"maxLength": 600,
"minLength": 1,
"description": "Bank image id/URL to start on."
},
"max_credits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Refuse (budget_exceeded + quote) above this."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5",
"21:9"
],
"type": "string",
"description": "Default 16:9. 21:9 and 4:5 only where list_models says the model takes them."
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 8,
"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."
},
"negative_prompt": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Where the model takes one."
}
},
"additionalProperties": false
}| language | string | As create_video. |
| site_url* | string | Any public http(s) URL on the site; the site is identified by its domain. |
| subtitles | boolean | As create_video. |
| brand_name | string | Name shown on the intro and outro cards. |
| max_videos | integer | At most this many videos in one call. Call again for the rest. |
| aspect_ratio | string | As create_video. |
| caption_style | string | As create_video. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url"
],
"properties": {
"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)."
},
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech",
"auto"
],
"type": "string",
"default": "auto",
"description": "As create_video."
},
"intro": {
"type": "boolean",
"default": true,
"description": "Include the branded opening title card."
},
"music": {
"type": "string",
"default": "auto",
"description": "As create_video."
},
"outro": {
"type": "boolean",
"default": true,
"description": "As create_video."
},
"theme": {
"type": "object",
"description": "As create_video."
},
"voice": {
"type": "string",
"default": "auto",
"description": "As create_video."
},
"confirm": {
"type": "boolean",
"default": false,
"description": "false (the default) previews the videos and spends nothing. true starts them and spends 40 credits each."
},
"idea_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "Which ideas from get_site_plan to make, in order. Omitted: every idea that has no video yet."
},
"language": {
"type": "string",
"default": "en",
"description": "As create_video."
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Any public http(s) URL on the site; the site is identified by its domain."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "As create_video."
},
"brand_name": {
"type": "string",
"maxLength": 60,
"description": "Name shown on the intro and outro cards."
},
"max_videos": {
"type": "integer",
"default": 5,
"maximum": 10,
"minimum": 1,
"description": "At most this many videos in one call. Call again for the rest."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"description": "As create_video."
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "As create_video."
}
},
"additionalProperties": false
}| object |
| As create_video, for this render. |
| captions_only | boolean | true re-times the subtitles on the existing voice track and renders again; nothing is re-recorded, re-scripted or re-voiced. The first resync after a paid render is free, the next costs a render's credits. |
| target_seconds | integer | What this film should run now, if it has legitimately grown or shrunk since creation. length_within_tolerance is measured against it and later re-renders keep it; their length fit aims at it (words you wrote are retimed, never rewritten). |
| idempotency_key | string | A caller-chosen id for this request. Sending the same key again within 24 hours returns the same re-render instead of starting and charging a second time — use it if your client may retry. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"video_id"
],
"properties": {
"draft": {
"type": "boolean",
"description": "As create_video; only before the first paid render."
},
"theme": {
"type": "object",
"description": "As create_video; replaces the video's theme and is kept for later re-renders."
},
"dry_run": {
"type": "boolean",
"description": "Quote only; nothing made or charged."
},
"outputs": {
"type": "array",
"description": "As create_video; must include this video's shape. Other shapes re-render their sibling or make one, a render each."
},
"video_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The video to re-render."
},
"max_credits": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Refuse (budget_exceeded + quote) above this."
},
"callback_url": {
"type": "string",
"description": "As create_video, for this render."
},
"quality_gate": {
"type": "object",
"description": "As create_video, for this render."
},
"captions_only": {
"type": "boolean",
"description": "true re-times the subtitles on the existing voice track and renders again; nothing is re-recorded, re-scripted or re-voiced. The first resync after a paid render is free, the next costs a render's credits."
},
"target_seconds": {
"type": "integer",
"maximum": 180,
"minimum": 15,
"description": "What this film should run now, if it has legitimately grown or shrunk since creation. length_within_tolerance is measured against it and later re-renders keep it; their length fit aims at it (words you wrote are retimed, never rewritten)."
},
"idempotency_key": {
"type": "string",
"maxLength": 128,
"minLength": 8,
"description": "A caller-chosen id for this request. Sending the same key again within 24 hours returns the same re-render instead of starting and charging a second time — use it if your client may retry."
}
},
"additionalProperties": false
}| font_family | string | A list_options face. |
| from_detect | boolean | Fill palette, face and logo from detect_brand first; your fields win. |
| logo_corner | string | Logo corner on the picture, or none. |
| caption_style | string | Default caption style. |
| font_asset_id | string | Font asset id (upload_asset kind "font"); outranks font_family. |
| logo_asset_id | string | Image asset id (upload_asset). |
| logo_safe_zone | number | Logo clear space, % of the short side. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"site_url"
],
"properties": {
"look": {
"enum": [
"clean",
"bold",
"editorial",
"playful",
"tech"
],
"type": "string",
"description": "Default look."
},
"intro": {
"enum": [
"card",
"none"
],
"type": "string",
"description": "Intro card template."
},
"model": {
"type": "string",
"maxLength": 60,
"description": "Clip model for ai_mode rich (list_models)."
},
"music": {
"type": "string",
"anyOf": [
{
"enum": [
"none",
"uplift",
"corporate",
"chill",
"cinematic",
"ambient",
"pulse",
"playful",
"warm"
]
},
{
"pattern": "^asset:[A-Za-z0-9_-]{1,64}$"
}
],
"description": "Default bed, or \"asset:<id>\"."
},
"voice": {
"enum": [
"Kore",
"Zephyr",
"Puck",
"Charon",
"Aoede",
"Fenrir",
"Leda",
"Orus",
"Callirrhoe",
"Achird",
"Sulafat",
"Sadachbia"
],
"type": "string",
"description": "Default narrator."
},
"colors": {
"type": [
"object",
"null"
],
"properties": {
"text": {
"type": [
"string",
"null"
]
},
"accent": {
"type": [
"string",
"null"
]
},
"primary": {
"type": [
"string",
"null"
]
},
"secondary": {
"type": [
"string",
"null"
]
},
"background": {
"type": [
"string",
"null"
]
}
},
"description": "Hex per slot; partial merges.",
"additionalProperties": false
},
"site_url": {
"type": "string",
"format": "uri",
"description": "Any URL of the site."
},
"watermark": {
"type": "boolean",
"description": "Paid plans: badge on or off. Free keeps it."
},
"end_screen": {
"enum": [
"cta",
"qr",
"social",
"logo",
"none"
],
"type": "string",
"description": "Outro card template."
},
"transition": {
"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"
],
"type": "string",
"description": "Default arrival for scenes naming none."
},
"font_family": {
"type": "string",
"maxLength": 48,
"description": "A list_options face."
},
"from_detect": {
"type": "boolean",
"description": "Fill palette, face and logo from detect_brand first; your fields win."
},
"logo_corner": {
"enum": [
"tl",
"tr",
"bl",
"br",
"none"
],
"type": "string",
"description": "Logo corner on the picture, or none."
},
"caption_style": {
"enum": [
"karaoke",
"bold",
"boxed",
"minimal",
"outline"
],
"type": "string",
"description": "Default caption style."
},
"font_asset_id": {
"type": "string",
"maxLength": 64,
"description": "Font asset id (upload_asset kind \"font\"); outranks font_family."
},
"logo_asset_id": {
"type": "string",
"maxLength": 64,
"description": "Image asset id (upload_asset)."
},
"logo_safe_zone": {
"type": "number",
"maximum": 12,
"minimum": 2,
"description": "Logo clear space, % of the short side."
}
},
"additionalProperties": false
}| routing | object | As create_format. |
| language | string | As create_format. |
| format_id* | string | The format_id from create_format or list_formats. |
| programme | object | As create_format. |
| subtitles | boolean | As create_format. |
| brand_name | string | As create_format. |
| aspect_ratio | string | As create_format. |
| focus_template | string | As create_format. |
| target_seconds | integer | As create_format. |
| title_template | string | As create_format. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format_id"
],
"properties": {
"goal": {
"enum": [
"explainer",
"ad",
"demo",
"tutorial",
"article"
],
"type": "string",
"description": "As create_format."
},
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "A new name."
},
"note": {
"type": "string",
"maxLength": 200,
"description": "What this version changes, for the version history."
},
"tone": {
"type": "string",
"description": "As create_format."
},
"intro": {
"type": "boolean",
"description": "As create_format."
},
"music": {
"type": "string",
"description": "As create_format."
},
"outro": {
"type": "boolean",
"description": "As create_format."
},
"theme": {
"type": "object",
"description": "As create_video."
},
"voice": {
"type": "string",
"description": "As create_format."
},
"scenes": {
"type": "array",
"description": "animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string."
},
"routing": {
"type": "object",
"description": "As create_format."
},
"language": {
"type": "string",
"description": "As create_format."
},
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The format_id from create_format or list_formats."
},
"programme": {
"type": "object",
"description": "As create_format."
},
"subtitles": {
"type": "boolean",
"description": "As create_format."
},
"brand_name": {
"type": "string",
"description": "As create_format."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"description": "As create_format."
},
"focus_template": {
"type": "string",
"description": "As create_format."
},
"target_seconds": {
"type": "integer",
"description": "As create_format."
},
"title_template": {
"type": "string",
"description": "As create_format."
}
},
"additionalProperties": false
}| max_credits_per_day | integer | A new daily credit cap (an episode is 40 credits). |
| max_episodes_per_run | integer | A new per-run cap. |
| format_version_latest | boolean | true unpins the show so it follows its format's latest version. |
| rotate_webhook_secret | boolean | webhook shows: mint a new signing secret (returned once in this call's webhook_secret); the old one stops working at once. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"show_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "A new name."
},
"active": {
"type": "boolean",
"description": "false pauses the show (the scheduler skips it, run_show refuses); true resumes it."
},
"source": {
"type": "object",
"description": "query shows: a new source (same shape as create_show)."
},
"cadence": {
"enum": [
"manual",
"hourly",
"daily",
"weekly"
],
"type": "string",
"description": "A new cadence."
},
"show_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The show_id from create_show or list_shows."
},
"format_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Move the show to another format of the same kind."
},
"watchlist": {
"type": "array",
"items": {
"type": "object",
"required": [
"title"
],
"properties": {
"key": {
"type": "string"
},
"date": {
"type": "string"
},
"link": {
"type": "string"
},
"image": {
"type": "string"
},
"title": {
"type": "string"
},
"summary": {
"type": "string"
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "watchlist shows: the new list; it replaces the old one. Items already made stay made."
},
"repeat_every": {
"enum": [
"none",
"month",
"quarter",
"year"
],
"type": "string",
"description": "query and watchlist shows: a new period, or none to stop repeating."
},
"format_version": {
"type": "integer",
"maximum": 100000,
"minimum": 1,
"description": "Pin the show to this version of its format."
},
"max_credits_per_day": {
"type": "integer",
"maximum": 2000,
"minimum": 40,
"description": "A new daily credit cap (an episode is 40 credits)."
},
"max_episodes_per_run": {
"type": "integer",
"maximum": 10,
"minimum": 1,
"description": "A new per-run cap."
},
"format_version_latest": {
"type": "boolean",
"description": "true unpins the show so it follows its format's latest version."
},
"rotate_webhook_secret": {
"type": "boolean",
"description": "webhook shows: mint a new signing secret (returned once in this call's webhook_secret); the old one stops working at once."
}
},
"additionalProperties": false
}| array |
| animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string. |
| routing | object | As create_format. |
| language | string | As create_format. |
| programme | object | As create_format. |
| subtitles | boolean | As create_format. |
| brand_name | string | As create_format. |
| aspect_ratio | string | As create_format. |
| focus_template | string | As create_format. |
| target_seconds | integer | As create_format. |
| title_template | string | As create_format. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"goal": {
"enum": [
"explainer",
"ad",
"demo",
"tutorial",
"article"
],
"type": "string",
"default": "explainer",
"description": "As create_format."
},
"kind": {
"enum": [
"video",
"animation"
],
"type": "string",
"default": "video",
"description": "video or animation."
},
"name": {
"type": "string",
"default": "Preview",
"maxLength": 80,
"minLength": 1,
"description": "The format's name, for {{show}}."
},
"tone": {
"type": "string",
"default": "energetic",
"description": "As create_format."
},
"intro": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"music": {
"type": "string",
"default": "auto",
"description": "As create_format."
},
"outro": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"theme": {
"type": "object",
"description": "As create_video."
},
"voice": {
"type": "string",
"default": "auto",
"description": "As create_format."
},
"scenes": {
"type": "array",
"description": "animation formats: the scene templates, as create_animation's scenes (not from_library), with the placeholders in any string."
},
"routing": {
"type": "object",
"description": "As create_format."
},
"language": {
"type": "string",
"default": "en",
"description": "As create_format."
},
"programme": {
"type": "object",
"description": "As create_format."
},
"subtitles": {
"type": "boolean",
"default": true,
"description": "As create_format."
},
"brand_name": {
"type": "string",
"description": "As create_format."
},
"aspect_ratio": {
"enum": [
"16:9",
"9:16",
"1:1",
"4:5"
],
"type": "string",
"default": "16:9",
"description": "As create_format."
},
"focus_template": {
"type": "string",
"description": "As create_format."
},
"target_seconds": {
"type": "integer",
"description": "As create_format."
},
"title_template": {
"type": "string",
"description": "As create_format."
}
},
"additionalProperties": false
}