List templates

Returns the catalog of intro/outro templates that can be applied via the branding parameter on the create_video and combine_video_clips endpoints.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authentication

Authorization: Bearer <YOUR_API_KEY>


Response

FieldTypeDescription
templatesTemplate[]List of available intro and outro branding templates.

Template

FieldTypeDescription
idstringTemplate identifier. Pass this as template in a branding slot.
namestringHuman-readable template name.
placementintro | outroIndicates whether the template can be used as an intro or outro.
orientationsstring[]Supported video orientations. Currently always ["landscape", "portrait"].
preview_urlstring | nullPreview image URL, if available.
fieldsTextField[]Text fields accepted by the template.
image_fieldsImageField[]Image fields accepted by the template. Omitted for templates without image slots.

TextField

FieldTypeDescription
keystringKey to use in the template's config object.
labelstringHuman-readable field name.
max_lengthinteger | nullMaximum allowed characters. null means unlimited.

ImageField

FieldTypeDescription
keystringKey to use in the template's config object.
labelstringHuman-readable field name.

Example

{
  "templates": [
    {
      "id": "gold-frame",
      "name": "Gold Frame",
      "placement": "intro",
      "orientations": ["landscape", "portrait"],
      "preview_url": null,
      "fields": [
        { "key": "title", "label": "Title", "max_length": 30 },
        { "key": "subtitle", "label": "Subtitle", "max_length": 20 },
        { "key": "detail", "label": "Detail", "max_length": null },
        { "key": "highlight_1", "label": "Highlight 1", "max_length": 20 },
        { "key": "highlight_2", "label": "Highlight 2", "max_length": 20 },
        { "key": "highlight_3", "label": "Highlight 3", "max_length": 20 }
      ]
    },
    {
      "id": "classic",
      "name": "Classic",
      "placement": "outro",
      "orientations": ["landscape", "portrait"],
      "preview_url": null,
      "fields": [
        { "key": "outro_text", "label": "Outro Text", "max_length": null }
      ],
      "image_fields": [
        { "key": "profile_picture", "label": "Profile Picture" },
        { "key": "brand_logo", "label": "Brand Logo" }
      ]
    }
  ]
}

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json