Templates

Templates in Synthesia

Templates are a feature in Synthesia that allow you to create rich content at scale. Templates may be created directly in Synthesia and may include all the features that it makes available; animated content, video backgrounds, etc.

This endpoint may be used to fetch information about the templates available to you, including the variables available for customisation.

Object Keys Type Description
id String Unique identifier for the template.
title String Title of the template.
description String Description of the template.
ctaSettings Object Settings for a call-to-action button.
ctaSettings.label String Label for a call-to-action button.
ctaSettings.url String URL to navigate to, when the call-to-action button is clicked.
variables Array A list of variables that may be provided at time of video creation.
variables[].id String The ID of the variable.
variables[].type String The variable type (for example, string).
variables[].value String If applicable, the default value of the variable. This applies for image and video variables.
createdAt Integer UNIX timestamp representing the time the template was created.
lastUpdatedAt Integer UNIX timestamp representing the time the template was last updated.