Top N reveal, Broadcast news 1.0.0
| Template | Top N reveal, tpl_26afa864dd36 |
|---|---|
| Variant | Broadcast news |
| 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 ranking of three to ten revealed as a countdown, from the last place to the first, one item per beat with its rank, name, value, a line and a picture, then all of them together as one list with number one at the top. 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: a kicker, what is ranked, the items in rank order (the first is number one) each with a name, a value, a line and a picture, how the pictures are laid in, the source and the look. | |
clipData.kicker | text | up to 20 characters | Kicker: A word above the title, such as TOP 5 or MOST READ. | |
clipData.title | text | yes | up to 80 characters | Title: What is ranked, by what and when. |
clipData.items | list | yes | at least 3, up to 10 | Ranking: In rank order: the first item is number one and is revealed last. Three to ten, each adding two seconds; the clip ends on all of them together as one list, turning pages where ten do not fit the frame. |
clipData.items[] | group | Item | ||
clipData.items[].name | text | yes | up to 36 characters | Name |
clipData.items[].value | number | 4 decimals | Value: Counted up as the item is revealed and written beside it in the list. Left out, none is shown. Every value is written with as many decimals as the most precise one. | |
clipData.items[].prefix | text | up to 3 characters | Prefix: Written before the value, such as a currency sign. | |
clipData.items[].unit | text | up to 16 characters | Unit: Written after the value: sold, readers, km. | |
clipData.items[].note | text | up to 90 characters | Line: One line about the item, shown while it is revealed. | |
clipData.items[].picture | image | media:// file from the media library, alt text up to 120 characters | Picture: Optional. Shown while the item is revealed and small in the list at the end. | |
clipData.pictureFit | enum | fill, whole | Picture fit: Fill each picture's frame for photographs; show the pictures whole for logos or cut-out products. | |
clipData.source | text | up to 60 characters | Source | |
clipData.look | group | Look: How the clip looks and moves within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides. | ||
clipData.look.theme | enum | auto, brand, light, dark, bold | Theme: The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page. | |
clipData.look.pace | enum | auto, calm, standard, punchy | Pace: How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts. | |
clipData.look.corners | enum | auto, square, soft, round | Corners: The shape of cards, panels and marks. | |
clipData.look.align | enum | auto, start, centre | Text alignment: Where the text lines up. | |
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": 20,
"title": "Kicker",
"description": "A word above the title, such as TOP 5 or MOST READ."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What is ranked, by what and when."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 36,
"title": "Name"
},
"value": {
"type": "number",
"title": "Value",
"description": "Counted up as the item is revealed and written beside it in the list. Left out, none is shown. Every value is written with as many decimals as the most precise one."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before the value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 16,
"title": "Unit",
"description": "Written after the value: sold, readers, km."
},
"note": {
"type": "string",
"maxLength": 90,
"title": "Line",
"description": "One line about the item, shown while it is revealed."
},
"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": "Optional. Shown while the item is revealed and small in the list at the end."
}
},
"required": [
"name"
],
"additionalProperties": false,
"title": "Item"
},
"minItems": 3,
"maxItems": 10,
"title": "Ranking",
"description": "In rank order: the first item is number one and is revealed last. Three to ten, each adding two seconds; the clip ends on all of them together as one list, turning pages where ten do not fit the frame."
},
"pictureFit": {
"type": "string",
"enum": [
"fill",
"whole"
],
"title": "Picture fit",
"description": "Fill each picture's frame for photographs; show the pictures whole for logos or cut-out products.",
"enumNames": [
"Fill the frame",
"Show it whole"
]
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source"
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"auto",
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page.",
"enumNames": [
"The style's own",
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"auto",
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts.",
"enumNames": [
"The style's own",
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"auto",
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, panels and marks.",
"enumNames": [
"The style's own",
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"auto",
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"The style's own",
"At the start of the line",
"Centred"
]
},
"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 within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides."
}
},
"required": [
"title",
"items"
],
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, what is ranked, the items in rank order (the first is number one) each with a name, a value, a line and a picture, how the pictures are laid in, the source and the look."
},
"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": 20,
"title": "Kicker",
"description": "A word above the title, such as TOP 5 or MOST READ."
},
"title": {
"type": "string",
"maxLength": 80,
"title": "Title",
"description": "What is ranked, by what and when."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 36,
"title": "Name"
},
"value": {
"type": "number",
"title": "Value",
"description": "Counted up as the item is revealed and written beside it in the list. Left out, none is shown. Every value is written with as many decimals as the most precise one."
},
"prefix": {
"type": "string",
"maxLength": 3,
"title": "Prefix",
"description": "Written before the value, such as a currency sign."
},
"unit": {
"type": "string",
"maxLength": 16,
"title": "Unit",
"description": "Written after the value: sold, readers, km."
},
"note": {
"type": "string",
"maxLength": 90,
"title": "Line",
"description": "One line about the item, shown while it is revealed."
},
"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": "Optional. Shown while the item is revealed and small in the list at the end."
}
},
"required": [
"name"
],
"additionalProperties": false,
"title": "Item"
},
"minItems": 3,
"maxItems": 10,
"title": "Ranking",
"description": "In rank order: the first item is number one and is revealed last. Three to ten, each adding two seconds; the clip ends on all of them together as one list, turning pages where ten do not fit the frame."
},
"pictureFit": {
"type": "string",
"enum": [
"fill",
"whole"
],
"title": "Picture fit",
"description": "Fill each picture's frame for photographs; show the pictures whole for logos or cut-out products.",
"enumNames": [
"Fill the frame",
"Show it whole"
]
},
"source": {
"type": "string",
"maxLength": 60,
"title": "Source"
},
"look": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"enum": [
"auto",
"brand",
"light",
"dark",
"bold"
],
"title": "Theme",
"description": "The style's own choice; your brand's own colours and background; a light or dark page tinted with your brand colour; or your brand colour as the page.",
"enumNames": [
"The style's own",
"Brand colours",
"Light",
"Dark",
"Bold brand colour"
]
},
"pace": {
"type": "string",
"enum": [
"auto",
"calm",
"standard",
"punchy"
],
"title": "Pace",
"description": "How things arrive: the style's own rhythm, calm fades, a standard rhythm, or punchy slams and cuts.",
"enumNames": [
"The style's own",
"Calm",
"Standard",
"Punchy"
]
},
"corners": {
"type": "string",
"enum": [
"auto",
"square",
"soft",
"round"
],
"title": "Corners",
"description": "The shape of cards, panels and marks.",
"enumNames": [
"The style's own",
"Square",
"Softly rounded",
"Round"
]
},
"align": {
"type": "string",
"enum": [
"auto",
"start",
"centre"
],
"title": "Text alignment",
"description": "Where the text lines up.",
"enumNames": [
"The style's own",
"At the start of the line",
"Centred"
]
},
"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 within its style. The same five switches in every format of the collections. Leave a switch out, or set it to the style's own, and the style decides."
}
},
"additionalProperties": false,
"title": "Clip data",
"description": "Everything drawn: a kicker, what is ranked, the items in rank order (the first is number one) each with a name, a value, a line and a picture, how the pictures are laid in, the source and the look."
},
"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_26afa864dd36?variant=Broadcast%20news&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": "Top 5",
"title": "The five best sellers in the Halden Gallery shop this autumn",
"items": [
{
"name": "Evening over the fells",
"note": "Giclée print, 50 x 70 cm, the shop's best seller since it opened in spring",
"unit": "sold",
"value": 1284,
"picture": {
"alt": "Hills under an evening sky, drawn in layers",
"url": "media://example-image.svg"
}
},
{
"name": "The autumn exhibition catalogue",
"note": "Two hundred pages, with an essay by each of the six artists in the show",
"unit": "sold",
"value": 1190
},
{
"name": "Silk dunes",
"note": "Sold out twice in October and reprinted in a larger size",
"unit": "sold",
"value": 1107,
"picture": {
"alt": "Soft waves of blue, violet and orange",
"url": "media://example-image.jpg"
}
},
{
"name": "Gallery tote bag",
"note": "Organic cotton, printed with the gallery's floor plan",
"unit": "sold",
"value": 948
},
{
"name": "Ink in water, no. 4",
"note": "New this year, from the photographer's first show with us",
"unit": "sold",
"value": 862,
"picture": {
"alt": "Clouds of red and blue ink in water",
"url": "media://example-image.png"
}
}
],
"pictureFit": "fill",
"source": "Halden Gallery shop tills, September to November",
"look": {
"theme": "auto",
"pace": "auto",
"corners": "auto",
"align": "auto",
"logo": "auto"
}
},
"metaData": {
"title": "The five best sellers in the Halden Gallery shop this autumn",
"captionTiny": "Evening over the fells was the best seller in the Halden Gallery shop this autumn, with 1,284 prints sold. Here is the top five.",
"captionShort": "Evening over the fells was the best seller in the Halden Gallery shop this autumn, with 1,284 prints sold. The exhibition catalogue came second and Silk dunes, sold out twice in October, third. The gallery tote bag and Ink in water, no. 4 complete the top five, counted from the shop tills.",
"captionMedium": "Evening over the fells was the best seller in the Halden Gallery shop this autumn, with 1,284 giclée prints sold. The autumn exhibition catalogue came second with 1,190 copies, two hundred pages with an essay by each of the six artists in the show. Silk dunes sold out twice in October and was reprinted in a larger size, finishing third with 1,107. The gallery tote bag, printed with the floor plan, came fourth with 948, and Ink in water, no. 4, new this year, fifth with 862. Counted from the shop tills from September to November.",
"captionLong": "Evening over the fells was the best seller in the Halden Gallery shop this autumn, with 1,284 giclée prints sold, and it has led the shop since it opened in spring. The autumn exhibition catalogue came second with 1,190 copies: two hundred pages, with an essay by each of the six artists in the show. Silk dunes sold out twice in October and was reprinted in a larger size, finishing third with 1,107. The gallery tote bag, in organic cotton and printed with the gallery's floor plan, came fourth with 948, and Ink in water, no. 4, from the photographer's first show with the gallery, came fifth with 862. Counted from the shop tills from September to November. Every print in the top five is still in stock in the shop and online.",
"hashtags": [
"bestsellers",
"galleryshop",
"prints",
"top5"
]
}
}
}
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.