v1
latestOpenAPI 3.0.22026-07-24296786.1 KBCreate a video from a template
Create a video based on a template created in Synthesia.
Request body
Optional folder ID. If provided, the new video will be created under this folder and inherit its permissions.
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.
Description of the video (used on the video's share page). Defaults to the template description.
Unique identifier of the template from which to create this video. This may be retrieved from the templates page in STUDIO.
Describes if the video is a test video. Test videos do not count towards your quota but are rendered with a watermark.
Title of the video (used on the video's share page). Defaults to the template title.
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.
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.
Response
Created.
Use callback ID to link videos back to the initial request. For example, if you are making a personalized video for a customer, you could enter the customer's email as a callback ID. This way, you can tell who the video is for, once its generated..
UNIX timestamp representing the time video was created.
Description of the video to be shown on the share page.
Test videos are free and not counted towards your quota. If you create a video in the “test” mode, we will overlay a watermark over your video.
Title of the video to be shown on the share page.
Public videos will be visible to anyone with a share URL.
Private videos can only be downloaded via a time-limited download link. See Retrieve a video for details.
Visibility can be changed also once the video is created via Update a video.