You can use this endpoint to bespoke video content. In case there is a feature that STUDIO provides that this API doesn't support, we recommend you use the video from template endpoint.
JSON Params | Description |
---|---|
test | Type: Boolean 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. |
title | Type: String Title of the video to be shown on the share page. |
description | Type: String Description of the video to be shown on the share page. |
visibility | Type: String Public videos will be visible to anyone with a share URL: https://share.synthesia.io/{VIDEO_ID}. 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. |
ctaSettings | Type: Object Settings for a call-to-action button. |
ctaSettings.label | Type: String Label for a call-to-action button. |
ctaSettings.url | Type: String URL to navigate to, when the call-to-action button is clicked. |
callbackId | Type: String Use callback ID, so you will be able to link videos (from e.g. list video endpoint) 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 will be able to tell who the video is for, once we have finished preparing it. |
input * | Type: Array of Objects 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[].scriptText * | Type: String Script for text-to-voice can be entered in any of the 34 supported languages. |
input[].scriptAudio | Type: String As an alternative to In case you use |
input[].scriptLanguage | Type: String Language code of the language the script audio was generated in. The Language code should be in the format: |
input[].avatar * | Type: String You can use one of our stock avatars (see Avatars for complete list) or your custom avatar (contact support to get the ID of your custom avatar). |
input[].avatarSettings | Type: Object Avatar settings. |
input[].avatarSettings.voice | Type: String See Voices for a complete list of voices. |
input[].avatarSettings.horizontalAlign | Type: String At the moment For example, horizontal alignment: |
input[].avatarSettings.scale | Type: Float The scale of the avatar. |
input[].avatarSettings.style | Type: String
The position of Use |
input[].avatarSettings.backgroundColor | Type: String HEX color code (e.g. |
input[].avatarSettings.seamless | Experimental. This is an experimental feature and has certain limitations. Type: Boolean When the seamless option is enabled, a video of the avatar will be generated in a way that first and last frames match, so videos can be concatenated seamlessly. Use seamless option, if you need to play videos back to back seamlessly e.g. in a video chatbot app. Limitations:
|
input[].background * | Type: String You can use one of our stock backgrounds (see below) or your custom background. For the custom background, you can provide the ID of an uploaded asset (see Create an asset), or URL from where we should download the background. Stock backgrounds: Transparent:
Solid
Image:
|
input[].backgroundSettings | Type: Object Background settings. |
input[].backgroundSettings.videoSettings | Type: Object Video settings. |
input[].backgroundSettings.videoSettings | Type: String Possible values:
|
input[].backgroundSettings.videoSettings | Type: String Possible values
|
soundtrack | Deprecated. We support soundtrack option only due to backward compatibility. We recommend you use our templates functionality for rich videos. See Create a video from a template. Type: String Possible values:
|
{
"test": true,
"title": "Hello, World!",
"description": "This is my first synthetic video, made with the Synthesia API!",
"visibility": "public",
"ctaSettings": {
"label": "Click me!",
"url": "https://www.synthesia.io"
},
"callbackId": "[email protected]",
"input": [{
"scriptText": "This is my first synthetic video, made with the Synthesia API!",
"scriptAudio": "12345678-1234-1234-1234-123456789012",
"scriptLanguage": "en-US",
"avatar": "anna_costume1_cameraA",
"avatarSettings": {
"voice": "1364e02b-bdae-4d39-bc2d-6c4a34814968",
"horizontalAlign": "center",
"scale": 1.0,
"style": "rectangular",
"backgroundColor": "#F2F7FF",
"seamless": false
},
"background": "off_white",
"backgroundSettings": {
"videoSettings": {
"shortBackgroundContentMatchMode": "freeze",
"longBackgroundContentMatchMode": "trim"
}
}
}],
"soundtrack": "urban"
}