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 KeysTypeDescription
idStringUnique identifier for the template.
titleStringTitle of the template.
descriptionStringDescription of the template.
ctaSettingsObjectSettings for a call-to-action button.
ctaSettings.labelStringLabel for a call-to-action button.
ctaSettings.urlStringURL to navigate to, when the call-to-action button is clicked.
variablesArrayA list of variables that may be provided at time of video creation.
variables[].idStringThe ID of the variable.
variables[].typeStringThe variable type (for example, string).
variables[].valueStringIf applicable, the default value of the variable. This applies for image and video variables.
createdAtIntegerUNIX timestamp representing the time template was created.
lastUpdatedAtIntegerUNIX timestamp representing the time template was last updated.