Templates

A template is a ready-made video: a layout, its motion and its length. You fill it in by name: the quote, the caption, the photos.

List the templates

curl https://sitebrite.app/api/v1/templates \
  -H "Authorization: Bearer $API_KEY"

{
  "templates": [
    {
      "id": "quote-reel",
      "title": "Review card",
      "description": "A customer’s words on a card, with a number counting up below.",
      "use": "Share a review and how many people you’ve helped.",
      "ratios": ["9x16", "1x1", "16x9"],
      "duration": 8,
      "fields": [
        { "name": "tag", "kind": "text", "label": "Where it’s from", "maxLength": 24, "example": "Shared by a customer" },
        { "name": "quote", "kind": "text", "label": "What they said", "maxLength": 150, "example": "They fixed our furnace the same afternoon…" },
        { "name": "count", "kind": "text", "label": "Number to count up to", "maxLength": 9, "example": "5,396" },
        { "name": "label", "kind": "text", "label": "What the number counts", "maxLength": 14, "example": "happy clients" }
      ],
      "lists": [],
      "brandFields": ["logo", "website"],
      "colors": ["bg", "surface", "text", "muted", "primary", "onPrimary", "accent", "dark", "onDark", "line"]
    },
    {
      "id": "table-dump",
      "title": "Photo dump",
      "fields": [
        { "name": "photo_1", "kind": "image", "label": "Photo 1" },
        { "name": "title", "kind": "text", "label": "Title", "maxLength": 30 },
        { "name": "caption", "kind": "text", "label": "Caption", "maxLength": 120, "emphasis": true }
      ],
      "lists": [{ "name": "photos", "label": "Photos", "min": 5, "items": [["photo_1"], ["photo_2"], ["photo_3"], ["photo_4"], ["photo_5"], ["photo_6"], ["photo_7"], ["photo_8"]] }]
    }
  ]
}

The example is shortened (the second template shows only some of its parts). Read the names from this list rather than copying them from here: templates gain names over time.

What each part means

• ratios: the sizes it comes in. 9x16 is tall (1080 × 1920), 1x1 square (1080 × 1080) and 16x9 wide (1920 × 1080).
• duration: its length in seconds, with every part filled in. Leaving list items out can make it shorter.
• fields: the names you fill in.
  • kind is text or image. An image takes the name of one of the brand's photos; see Brands and photos.
  • maxLength is the longest text that fits in every size. Longer text is accepted, but it may not fit.
  • emphasis: true means words between asterisks stand out, like "A *book*, not a tablet".
  • example is sample text, to show what kind of words go there.
• lists: groups of names that repeat, like the photos in a photo dump. Each item is a list of names. Fill at least min items; the list closes up around items you leave out.
• brandFields: names the brand fills: its logo and its web address. You can't set these in a render.
• colors: the template's palette. Set one as palette.<name> with a color like #1a73e8. primary, onPrimary and accent start as your brand's colors; the others start as the template's own.

Names you leave out

A name you don't fill in is left out of the video, not filled with sample text. Leave out an item of a list and the items after it move up. Fill in everything you want to show.