Synthesia APIs
IntegrationsHelp centerSynthesia UpdatesLog in

Create a video from a template

post
https://api.synthesia.io/v2/videos/fromTemplate

Create a video based on a template created in Synthesia.

Body Params
uuid | null
Defaults to null

Optional folder ID. If provided, the new video will be created under this folder and inherit its permissions.

string

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.

ctaSettings
object
string

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

uuid
required

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

templateData
object
required
boolean
Defaults to false

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

string

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

string
enum
Defaults 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:
string | null

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.

Responses

Updated about 2 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago