SYsynthesia
Templates

Retrieve a template

You can use Retrieve a template endpoint to pull information on a template. In particular, you may use it to find out the variables available for customisation.

get/v2/templates/{template_id}

Request

Path parameters

template_idstring required

The ID of the template to be retrieved.

Response

OK.

callbackIdstring

A callback ID that you may attach to the Video object. This is useful in the scenario where you need to store additional metadata on the video.

createdAtinteger
descriptionstring

Description of the video (used on the video's share page). Defaults to the template description.

templateIdstring uuid required

Unique identifier of the template from which to create this video. This may be retrieved from the templates page in STUDIO.

templateDataobject required
testboolean

Describes if the video is a test video. Test videos do not count towards your quota but are rendered with a watermark.

titlestring

Title of the video (used on the video's share page). Defaults to the template title.

visibility'private' | 'public'

Describes the private settings of the video. - If public, the video's share page is active. - If private, the video's share page is not active; visitors will receive a 404 Not Found response.

brandKitIdstring nullable

Brand kit ID for the video. Defaults to 'workspace_default' if not set. Use 'no_brand_kit' for no branding, or a UUID for a custom brand kit.

downloadstring
durationstring
idstring uuid
lastUpdatedAtinteger
variablesobject[]

Changes

No recorded changes to this operation across all 1 revision of this API.