Tech, How-to 1.0.0
| Template | Tech, tpl_46549cf45b15 |
|---|---|
| Variant | How-to |
| Version | 1.0.0, the newest: what a channel following this variant draws |
| Shapes | 9x16, 4x5, 1x1, 16x9, 2x3 |
| Length | 15 seconds |
Example video
The 1x1 cut of this version, drawn from its own worked example. Open the video on its own.
What it accepts
A tutorial in two to six steps: a headline, how long it takes, then each step with its screenshot or picture, a caption and, where you like, the spot to look at, and at the end every step ticked off with the call to action. The clip is as long as the steps need. metaData is the post's title, descriptions and hashtags and is never drawn.
| Field | Type | Required | Limit | What it is |
|---|---|---|---|---|
clipData | group | yes | Clip data: Everything drawn in the clip: the headline, the steps with their screenshots and captions, the takeaway and the call to action. | |
clipData.kicker | text | up to 32 characters | Kicker: A short line above the headline, such as Quick guide or Tip of the week. | |
clipData.headline | text | yes | up to 64 characters | Headline: What the viewer will be able to do. |
clipData.subline | text | up to 100 characters | Subline: One line under the headline: who it is for or what they need. | |
clipData.duration | text | up to 24 characters | Time it takes: How long it takes, as it should be read, such as 5 minutes. | |
clipData.level | text | up to 24 characters | Level: Who it is for, such as Beginner or Admins only. | |
clipData.steps | list | yes | at least 2, up to 6 | Steps: Two to six steps, shown one after another in order; the clip gets two and a half seconds longer for each. |
clipData.steps[] | group | Step | ||
clipData.steps[].title | text | yes | up to 44 characters | Title: What to do, in a few words. |
clipData.steps[].caption | text | up to 90 characters | Caption: The detail: where to find it, what to type, what to expect. | |
clipData.steps[].picture | image | media:// file from the media library, alt text up to 120 characters | Picture: A screenshot or picture of the step, any shape; it is shown whole, never cropped. Without one the step shows its icon. | |
clipData.steps[].icon | enum | check, circle-check, x, arrow-right, arrow-up-right, plus, star, heart, thumbs-up, sparkles, zap, clock, calendar, map-pin, info, triangle-alert, lightbulb, target, award, crown, gem, flame, timer, list-checks, clipboard-check, badge-check, hand-heart, rocket, trophy, megaphone, bell, qr-code, ticket, gift, key-round, book-open, graduation-cap, house, phone, mail, globe, users, user, cpu, cloud, code, settings, smartphone, laptop, database, bot, factory, gauge, wrench, wifi, battery-charging, plug-zap, server, layers, puzzle, workflow, boxes, hard-hat | Icon: A line icon for the step, shown where there is no picture and in the closing checklist. | |
clipData.steps[].pointX | number | from 0, to 100, 1 decimals | Look here, across: Where on the picture to point, in percent from its left edge (0 to 100). Send it with the one below; a pointer moves there and clicks. | |
clipData.steps[].pointY | number | from 0, to 100, 1 decimals | Look here, down: Where on the picture to point, in percent from its top edge (0 to 100). | |
clipData.takeaway | text | up to 90 characters | Takeaway: One line at the end with the steps ticked off: what they have now. | |
clipData.cta | group | Call to action: The button at the end and the line under it, such as a web address, a handle or a phone number. | ||
clipData.cta.label | text | yes | up to 28 characters | Button: What the button says. |
clipData.cta.detail | text | up to 48 characters | Line under it: An address, a handle, a phone number. | |
clipData.disclaimer | text | up to 120 characters | Small print: A note that must be shown, such as a plan the feature needs. | |
clipData.look | group | Look: How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default. | ||
clipData.look.theme | enum | brand, light, dark, bold | Theme: Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page. | |
clipData.look.pace | enum | calm, standard, punchy | Pace: How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts. | |
clipData.look.corners | enum | square, soft, round | Corners: The shape of cards, pictures and buttons. | |
clipData.look.align | enum | start, centre | Text alignment: Where the text lines up. | |
clipData.look.device | enum | window, phone, plain | Screenshot frame: What the screenshots are shown in: an app window, a phone, or a plain card. | |
clipData.look.zoom | boolean | Zoom in where to look: Once the pointer has clicked, the picture moves closer around that spot. Only for steps that say where to look. | ||
clipData.look.logo | enum | auto, free | Logo: The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose. | |
metaData | group | Meta data: Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data. | ||
metaData.title | text | up to 100 characters | Title: Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes. | |
metaData.captionTiny | text | up to 200 characters | Tiny description (Pinterest, Threads, X): Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionShort | text | up to 500 characters | Short description (Telegram, Threema, WeChat, WhatsApp): Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionMedium | text | up to 1500 characters | Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok): Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.captionLong | text | up to 4000 characters | Long description (Facebook Feed, YouTube): Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit. | |
metaData.hashtags | list | up to 15 | Hashtags: Written without the #. Up to 15, which every platform takes. | |
metaData.hashtags[] | text | up to 60 characters | Hashtag |
locales carries other languages: under each language code, the parts of clipData and metaData that differ, laid over the default, so a language with no copy still renders.
A picture is always a file from your media library: media:// followed by its id or its name.
Anything the table does not list is refused, and so is anything over its limit, with a 422 that
names the field.
The JSON Schema
{
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"kicker": {
"type": "string",
"maxLength": 32,
"title": "Kicker",
"description": "A short line above the headline, such as Quick guide or Tip of the week."
},
"headline": {
"type": "string",
"maxLength": 64,
"title": "Headline",
"description": "What the viewer will be able to do."
},
"subline": {
"type": "string",
"maxLength": 100,
"title": "Subline",
"description": "One line under the headline: who it is for or what they need."
},
"duration": {
"type": "string",
"maxLength": 24,
"title": "Time it takes",
"description": "How long it takes, as it should be read, such as 5 minutes."
},
"level": {
"type": "string",
"maxLength": 24,
"title": "Level",
"description": "Who it is for, such as Beginner or Admins only."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 44,
"title": "Title",
"description": "What to do, in a few words."
},
"caption": {
"type": "string",
"maxLength": 90,
"title": "Caption",
"description": "The detail: where to find it, what to type, what to expect."
},
"picture": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"pattern": "^media:\\/\\/[^\\s/\\\\\\u0000-\\u001f][^/\\\\\\u0000-\\u001f]{0,254}$",
"title": "Picture",
"description": "A file from the workspace's media library, written media:// and the file's id or name. A web address is refused."
},
"alt": {
"type": "string",
"maxLength": 120,
"title": "Alt text",
"description": "What the picture shows, for anyone who cannot see it."
}
},
"required": [
"url"
],
"additionalProperties": false,
"title": "Picture",
"description": "A screenshot or picture of the step, any shape; it is shown whole, never cropped. Without one the step shows its icon."
},
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"cpu",
"cloud",
"code",
"settings",
"smartphone",
"laptop",
"database",
"bot",
"factory",
"gauge",
"wrench",
"wifi",
"battery-charging",
"plug-zap",
"server",
"layers",
"puzzle",
"workflow",
"boxes",
"hard-hat"
],
"title": "Icon",
"description": "A line icon for the step, shown where there is no picture and in the closing checklist.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Cpu",
"Cloud",
"Code",
"Settings",
"Smartphone",
"Laptop",
"Database",
"Bot",
"Factory",
"Gauge",
"Wrench",
"Wifi",
"Battery charging",
"Plug zap",
"Server",
"Layers",
"Puzzle",
"Workflow",
"Boxes",
"Hard hat"
]
},
"pointX": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Look here, across",
"description": "Where on the picture to point, in percent from its left edge (0 to 100). Send it with the one below; a pointer moves there and clicks."
},
"pointY": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Look here, down",
"description": "Where on the picture to point, in percent from its top edge (0 to 100)."
}
},
"required": [
"title"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 2,
"maxItems": 6,
"title": "Steps",
"description": "Two to six steps, shown one after another in order; the clip gets two and a half seconds longer for each."
},
"takeaway": {
"type": "string",
"maxLength": 90,
"title": "Takeaway",
"description": "One line at the end with the steps ticked off: what they have now."
},
"cta": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 28,
"title": "Button",
"description": "What the button says."
},
"detail": {
"type": "string",
"maxLength": 48,
"title": "Line under it",
"description": "An address, a handle, a phone number."
}
},
"required": [
"label"
],
"additionalProperties": false,
"title": "Call to action",
"description": "The button at the end and the line under it, such as a web address, a handle or a phone number."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "A note that must be shown, such as a plan the feature needs."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page.",
"enumNames": [
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts.",
"enumNames": [
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, pictures and buttons.",
"enumNames": [
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"At the start of the line",
"Centred"
]
},
"device": {
"type": "string",
"enum": [
"window",
"phone",
"plain"
],
"title": "Screenshot frame",
"description": "What the screenshots are shown in: an app window, a phone, or a plain card.",
"enumNames": [
"App window",
"Phone",
"Plain card"
]
},
"zoom": {
"type": "boolean",
"title": "Zoom in where to look",
"description": "Once the pointer has clicked, the picture moves closer around that spot. Only for steps that say where to look."
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default."
}
},
"required": [
"headline",
"steps"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the headline, the steps with their screenshots and captions, the takeaway and the call to action."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
},
"locales": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"clipData": {
"type": "object",
"properties": {
"kicker": {
"type": "string",
"maxLength": 32,
"title": "Kicker",
"description": "A short line above the headline, such as Quick guide or Tip of the week."
},
"headline": {
"type": "string",
"maxLength": 64,
"title": "Headline",
"description": "What the viewer will be able to do."
},
"subline": {
"type": "string",
"maxLength": 100,
"title": "Subline",
"description": "One line under the headline: who it is for or what they need."
},
"duration": {
"type": "string",
"maxLength": 24,
"title": "Time it takes",
"description": "How long it takes, as it should be read, such as 5 minutes."
},
"level": {
"type": "string",
"maxLength": 24,
"title": "Level",
"description": "Who it is for, such as Beginner or Admins only."
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 44,
"title": "Title",
"description": "What to do, in a few words."
},
"caption": {
"type": "string",
"maxLength": 90,
"title": "Caption",
"description": "The detail: where to find it, what to type, what to expect."
},
"picture": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"pattern": "^media:\\/\\/[^\\s/\\\\\\u0000-\\u001f][^/\\\\\\u0000-\\u001f]{0,254}$",
"title": "Picture",
"description": "A file from the workspace's media library, written media:// and the file's id or name. A web address is refused."
},
"alt": {
"type": "string",
"maxLength": 120,
"title": "Alt text",
"description": "What the picture shows, for anyone who cannot see it."
}
},
"required": [
"url"
],
"additionalProperties": false,
"title": "Picture",
"description": "A screenshot or picture of the step, any shape; it is shown whole, never cropped. Without one the step shows its icon."
},
"icon": {
"type": "string",
"enum": [
"check",
"circle-check",
"x",
"arrow-right",
"arrow-up-right",
"plus",
"star",
"heart",
"thumbs-up",
"sparkles",
"zap",
"clock",
"calendar",
"map-pin",
"info",
"triangle-alert",
"lightbulb",
"target",
"award",
"crown",
"gem",
"flame",
"timer",
"list-checks",
"clipboard-check",
"badge-check",
"hand-heart",
"rocket",
"trophy",
"megaphone",
"bell",
"qr-code",
"ticket",
"gift",
"key-round",
"book-open",
"graduation-cap",
"house",
"phone",
"mail",
"globe",
"users",
"user",
"cpu",
"cloud",
"code",
"settings",
"smartphone",
"laptop",
"database",
"bot",
"factory",
"gauge",
"wrench",
"wifi",
"battery-charging",
"plug-zap",
"server",
"layers",
"puzzle",
"workflow",
"boxes",
"hard-hat"
],
"title": "Icon",
"description": "A line icon for the step, shown where there is no picture and in the closing checklist.",
"enumNames": [
"Check",
"Circle check",
"X",
"Arrow right",
"Arrow up right",
"Plus",
"Star",
"Heart",
"Thumbs up",
"Sparkles",
"Zap",
"Clock",
"Calendar",
"Map pin",
"Info",
"Triangle alert",
"Lightbulb",
"Target",
"Award",
"Crown",
"Gem",
"Flame",
"Timer",
"List checks",
"Clipboard check",
"Badge check",
"Hand heart",
"Rocket",
"Trophy",
"Megaphone",
"Bell",
"Qr code",
"Ticket",
"Gift",
"Key round",
"Book open",
"Graduation cap",
"House",
"Phone",
"Mail",
"Globe",
"Users",
"User",
"Cpu",
"Cloud",
"Code",
"Settings",
"Smartphone",
"Laptop",
"Database",
"Bot",
"Factory",
"Gauge",
"Wrench",
"Wifi",
"Battery charging",
"Plug zap",
"Server",
"Layers",
"Puzzle",
"Workflow",
"Boxes",
"Hard hat"
]
},
"pointX": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Look here, across",
"description": "Where on the picture to point, in percent from its left edge (0 to 100). Send it with the one below; a pointer moves there and clicks."
},
"pointY": {
"type": "number",
"minimum": 0,
"maximum": 100,
"title": "Look here, down",
"description": "Where on the picture to point, in percent from its top edge (0 to 100)."
}
},
"required": [
"title"
],
"additionalProperties": false,
"title": "Step"
},
"minItems": 2,
"maxItems": 6,
"title": "Steps",
"description": "Two to six steps, shown one after another in order; the clip gets two and a half seconds longer for each."
},
"takeaway": {
"type": "string",
"maxLength": 90,
"title": "Takeaway",
"description": "One line at the end with the steps ticked off: what they have now."
},
"cta": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 28,
"title": "Button",
"description": "What the button says."
},
"detail": {
"type": "string",
"maxLength": 48,
"title": "Line under it",
"description": "An address, a handle, a phone number."
}
},
"additionalProperties": false,
"title": "Call to action",
"description": "The button at the end and the line under it, such as a web address, a handle or a phone number."
},
"disclaimer": {
"type": "string",
"maxLength": 120,
"title": "Small print",
"description": "A note that must be shown, such as a plan the feature needs."
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "Brand: your brand's own colours and background. Light or dark: a page tinted with your brand colour. Bold: your brand colour as the page.",
"enumNames": [
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: calm fades, a standard rhythm, or punchy slams and hard cuts.",
"enumNames": [
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, pictures and buttons.",
"enumNames": [
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"At the start of the line",
"Centred"
]
},
"device": {
"type": "string",
"enum": [
"window",
"phone",
"plain"
],
"title": "Screenshot frame",
"description": "What the screenshots are shown in: an app window, a phone, or a plain card.",
"enumNames": [
"App window",
"Phone",
"Plain card"
]
},
"zoom": {
"type": "boolean",
"title": "Zoom in where to look",
"description": "Once the pointer has clicked, the picture moves closer around that spot. Only for steps that say where to look."
},
"logo": {
"type": "string",
"enum": [
"auto",
"free"
],
"title": "Logo",
"description": "The style's own: the logo on the style's plate (a card, a disc, a badge) so it reads on any page. As it is: the logo whole, with no plate, frame or crop, for a logo made to stand on the page, such as one with a transparent background. As it is, make sure your logo reads on the page of the theme you choose.",
"enumNames": [
"The style's own",
"As it is, no plate or crop"
]
}
},
"additionalProperties": false,
"title": "Look",
"description": "How the clip looks and moves. The same five switches in every format (theme, pace, corners, alignment, logo), plus this format's own. Leave any out for the format's default."
}
},
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn in the clip: the headline, the steps with their screenshots and captions, the takeaway and the call to action."
},
"metaData": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 100,
"title": "Title",
"description": "Used where the platform has a title of its own: Facebook Feed, LinkedIn, Pinterest and YouTube. Up to 100 characters, which every one of them takes."
},
"captionTiny": {
"type": "string",
"maxLength": 200,
"title": "Tiny description (Pinterest, Threads, X)",
"description": "Up to 200 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionShort": {
"type": "string",
"maxLength": 500,
"title": "Short description (Telegram, Threema, WeChat, WhatsApp)",
"description": "Up to 500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionMedium": {
"type": "string",
"maxLength": 1500,
"title": "Medium description (Discord, Facebook Reels, Instagram, LinkedIn, Signal, Slack, TikTok)",
"description": "Up to 1500 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"captionLong": {
"type": "string",
"maxLength": 4000,
"title": "Long description (Facebook Feed, YouTube)",
"description": "Up to 4000 characters. The brand's description, link and hashtags follow it within the platform's limit."
},
"hashtags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"title": "Hashtag"
},
"maxItems": 15,
"title": "Hashtags",
"description": "Written without the #. Up to 15, which every platform takes."
}
},
"additionalProperties": false,
"title": "Meta data",
"description": "Everything about the post that is never drawn in the clip: its title, its description in four lengths, one per kind of platform, and its hashtags. Reelwire adds the brand's description, link and hashtags after it. Left out, the post text is generated from the clip data."
}
},
"additionalProperties": false
},
"propertyNames": {
"enum": [
"aa",
"ab",
"ae",
"af",
"ak",
"am",
"an",
"ar",
"as",
"av",
"ay",
"az",
"ba",
"be",
"bg",
"bi",
"bm",
"bn",
"bo",
"br",
"bs",
"ca",
"ce",
"ch",
"co",
"cr",
"cs",
"cu",
"cv",
"cy",
"da",
"de",
"dv",
"dz",
"ee",
"el",
"en",
"eo",
"es",
"et",
"eu",
"fa",
"ff",
"fi",
"fj",
"fo",
"fr",
"fy",
"ga",
"gd",
"gl",
"gn",
"gu",
"gv",
"ha",
"he",
"hi",
"ho",
"hr",
"ht",
"hu",
"hy",
"hz",
"ia",
"id",
"ie",
"ig",
"ii",
"ik",
"io",
"is",
"it",
"iu",
"ja",
"jv",
"ka",
"kg",
"ki",
"kj",
"kk",
"kl",
"km",
"kn",
"ko",
"kr",
"ks",
"ku",
"kv",
"kw",
"ky",
"la",
"lb",
"lg",
"li",
"ln",
"lo",
"lt",
"lu",
"lv",
"mg",
"mh",
"mi",
"mk",
"ml",
"mn",
"mr",
"ms",
"mt",
"my",
"na",
"nb",
"nd",
"ne",
"ng",
"nl",
"nn",
"no",
"nr",
"nv",
"ny",
"oc",
"oj",
"om",
"or",
"os",
"pa",
"pi",
"pl",
"ps",
"pt",
"qu",
"rm",
"rn",
"ro",
"ru",
"rw",
"sa",
"sc",
"sd",
"se",
"sg",
"si",
"sk",
"sl",
"sm",
"sn",
"so",
"sq",
"sr",
"ss",
"st",
"su",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"ti",
"tk",
"tl",
"tn",
"to",
"tr",
"ts",
"tt",
"tw",
"ty",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zh",
"zu",
"zh-CN",
"zh-TW",
"pt-BR"
]
}
}
},
"required": [
"clipData"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}
Ask Reelwire for the same document yourself, without signing in:
curl "http://localhost:4000/v1/formats/template/tpl_46549cf45b15?variant=How-to&version=1.0.0"
Delivery JSON
Your own system sends this to one of your streams, POST /v1/stream, and every channel listening to
that stream draws it with its template. data is the document described above; a stream with an
empty field map passes it to the template unchanged. Try it first on POST /v1/stream/validate,
which answers the same without publishing anything. Streams and feeds
explains the rest, including how to map a document of your own shape instead.
{
"streamId": "st_your_stream_id",
"eventId": "01M2SQMKK3G1NVFXV31DCBVB95",
"occurredAt": "2026-09-23T07:00:00Z",
"locale": "en",
"data": {
"clipData": {
"kicker": "Quick start guide",
"headline": "Connect your first data source in four steps",
"subline": "No code and no tickets: from sign-in to your first live chart before your coffee cools.",
"duration": "About 5 minutes",
"level": "Beginner friendly",
"steps": [
{
"icon": "layers",
"title": "Open Data sources",
"pointX": 7.5,
"pointY": 31.6,
"caption": "In the sidebar, choose Data sources. It is the fourth entry, just under Dashboards.",
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
}
},
{
"icon": "database",
"title": "Pick your warehouse",
"pointX": 47.3,
"pointY": 76,
"caption": "Search the gallery and choose your warehouse. More than forty are supported.",
"picture": {
"alt": "Hills under an evening sky, drawn in layers",
"url": "media://example-image.svg"
}
},
{
"icon": "plug-zap",
"title": "Paste the read-only key",
"pointX": 72.8,
"pointY": 85,
"caption": "Paste the key your admin gave you, keep Sync every minute on and press Connect.",
"picture": {
"alt": "Clouds of red and blue ink in water",
"url": "media://example-image.png"
}
},
{
"icon": "gauge",
"title": "Watch it go live",
"pointX": 84.4,
"pointY": 13.2,
"caption": "The first sync takes under a minute. Your charts fill in and update from now on.",
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
}
}
],
"takeaway": "That is it: your dashboards now refresh on their own, every minute.",
"cta": {
"label": "Read the full guide",
"detail": "docs.lumenlabs.example/connect"
},
"disclaimer": "Live sync is part of the Team and Enterprise plans.",
"look": {
"theme": "brand",
"pace": "standard",
"corners": "soft",
"align": "start",
"device": "window",
"zoom": true,
"logo": "auto"
}
},
"metaData": {
"title": "Connect your first data source in four steps",
"captionTiny": "Four steps from sign-in to your first live chart: open Data sources, pick your warehouse, paste the key, done.",
"captionShort": "Connect your first data source in about five minutes: open Data sources, pick your warehouse, paste the read-only key and press Connect. Your dashboards update every minute from then on.",
"captionMedium": "Connect your first data source in four steps, no code and no tickets. Open Data sources in the sidebar, pick your warehouse from the gallery of more than forty connectors, paste the read-only key your admin gave you and press Connect. The first sync takes under a minute, and from then on your dashboards refresh on their own, every minute. Live sync is part of the Team and Enterprise plans. The full guide is in our docs.",
"captionLong": "Connect your first data source in four steps, no code and no tickets. Open Data sources in the sidebar, just under Dashboards. Search or scroll the gallery and choose your warehouse: more than forty are supported. Paste the read-only key your admin gave you, keep Sync every minute switched on and press Connect. The first sync takes under a minute, your charts fill in, and from then on your dashboards refresh on their own, every minute. Live sync is part of the Team and Enterprise plans. The full guide, with screenshots for every warehouse, is in our docs.",
"hashtags": [
"howto",
"lumenlabs",
"dataengineering",
"analytics"
]
}
}
}
The delivery names no version: which build draws it is the channel's choice, the newest of its
variant or the one it is pinned to. eventId is a ULID you make once per event: sending the same
one again changes nothing. occurredAt is when the thing happened, not when you sent it. locale
is the language of the text in data, and data.locales carries other languages beside it.