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 within your Synthesia account. To get started on this endpoint check the API Quickstart guide.
Authentication
Authorizationstring
API Key authentication via header
Request
This endpoint expects an object.
inputlist of objectsRequired
An array of objects that each describe a clip of a multi-clip video. You can think of the clips as different scenes in the video.
folderIdstring or nullOptionalformat: "uuid"
Optional folder ID. If provided, the new video will be created under this folder and inherit its permissions.
aspectRatioenumOptionalDefaults to 16:9
Aspect ratio of the video. Default is landscape (16:9).
Allowed values:
ctaSettingsobjectOptional
Settings for a call-to-action button.
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..
descriptionstringOptionalDefaults to
Description of the video to be shown on the share page.
soundtrackenumOptional
soundtrack option is supported for backward compatibility. You should use the templates functionality for rich videos.
Allowed values:
soundSettingsobjectOptional
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.
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:
Response
OK.
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.
