SYsynthesia
Videos

Create a video

Create a video within your Synthesia account. To get started on this endpoint check the API Quickstart guide.

post/v2/videos

Request

Request body

folderIdstring uuid nullable

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

aspectRatio'16:9' | '9:16' | '1:1' | '4:5' | '5:4'

Aspect ratio of the video. Default is landscape (16:9).

callbackIdstring

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..

descriptionstring

Description of the video to be shown on the share page.

soundtrack'corporate' | 'inspirational' | 'modern' | 'urban'

soundtrack option is supported for backward compatibility. You should use the templates functionality for rich videos.

testboolean

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.

titlestring

Title of the video to be shown on the share page.

visibility'private' | 'public'

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.

Response

OK.

callbackIdstring

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..

createdAtinteger

UNIX timestamp representing the time video was created.

descriptionstring

Description of the video to be shown on the share page.

testboolean

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.

downloadstring
durationstring
idstring uuid
lastUpdatedAtinteger
status'complete' | 'deleted' | 'error' | 'in_progress' | 'rejected' | 'approved'
titlestring

Title of the video to be shown on the share page.

visibility'private' | 'public'

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.

Changes

No recorded changes to this operation across all 1 revision of this API.