Synthesia APIs
IntegrationsHelp centerSynthesia UpdatesLog in

Create a video

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

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

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
enum
Defaults to 16:9

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

Allowed:
ctaSettings
object

Settings for a call-to-action button.

string

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

string

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

input
array of objects
required

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.

input*
string
enum

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

Allowed:
soundSettings
object
boolean
Defaults 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.

string

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

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