For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Create a video based on a template created in Synthesia.
Authentication
Authorizationstring
API Key authentication via header
Request
This endpoint expects an object.
templateIdstringRequiredformat: "uuid"
Unique identifier of the template from which to create this video. This may be retrieved from the templates page in STUDIO.
templateDataobjectRequired
folderIdstring or nullOptionalformat: "uuid"
Optional folder ID. If provided, the new video will be created under this folder and inherit its permissions.
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.
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.
Response
Created.
callbackIdstringOptional
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..
createdAtintegerOptional
UNIX timestamp representing the time video was created.
ctaSettingsobjectOptional
Settings for a call-to-action button.
descriptionstringOptionalDefaults to
Description of the video to be shown on the share page.
testbooleanOptionalDefaults to false
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.
downloadstringOptional
Withheld for rejected videos and videos held for moderation review.
durationstringOptional
idstringOptionalformat: "uuid"
lastUpdatedAtintegerOptional
statusenumOptional
Video status. A rendered video that is still awaiting moderation review is reported as in_progress until the review is final.
thumbnailobject or nullOptional
titlestringOptionalDefaults to
Title of the video to be shown on the share page.
visibilityenumOptionalDefaults to private
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.
Allowed values:
captionsobjectOptional
Downloadable captions files. Omitted when no captions are available, and for videos that are rejected or held for moderation review.
contentProvenanceobject or nullOptional
Content provenance (C2PA) information for the video. Only present when the video has been signed.
