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.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

template_idstringRequired

The ID of the template to be retrieved.

Response

OK.

templateIdstringformat: "uuid"

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

templateDataobject

callbackIdstringOptional

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.

createdAtintegerOptional

ctaSettingsobjectOptional

descriptionstringOptional

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

testbooleanOptionalDefaults to false

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

titlestringOptional

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

visibilityenumOptionalDefaults to private

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.

Allowed values:

brandKitIdstring or nullOptional

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.

downloadstringOptional

durationstringOptional

idstringOptionalformat: "uuid"

lastUpdatedAtintegerOptional

variableslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error