URL Expired

The URL for this request expired after 30 days.

folderId

uuid | null

Defaults to null

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

aspectRatio

string

enum

Defaults to 16:9

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

Allowed:

16:9``9:16``1:1``4:5``5:4

ctaSettings

object

Settings for a call-to-action button.

callbackId

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

description

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.

soundtrack

string

enum

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

Allowed:

corporate``inspirational``modern``urban

soundSettings

object

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.

truefalse

title

string

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

visibility

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:

private``public

``200 OK.

object

callbackId

string

createdAt

integer

UNIX timestamp representing the time video was created.

ctaSettings

object

Settings for a call-to-action button.

label

string

required

Label for a call-to-action button.

url

string

required

^(?:(?:(?:https?|ftp):)?//)?(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+(?:[a-z\u00a1-\uffff]{2,}\.?))(?::\d{2,5})?(?:[/?#]\S*)?$

URL to navigate to, when the call-to-action button is clicked.

description

string

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

test

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.

download

string

duration

string

id

uuid

lastUpdatedAt

integer

status

string

enum

complete``deleted``error``in_progress``rejected``approved

thumbnail

object | null

image

string | null

Defaults to null

gif

string | null

Defaults to null

title

string

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

visibility

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:

private``public

``400 Bad Request.

``403 Forbidden - Wrong API key.

``default Unexpected Server error.

Updated 2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \
     --url https://api.synthesia.io/v2/videos \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "folderId": null,\n  "aspectRatio": "16:9",\n  "soundSettings": {\n    "defaultSoundtrackVolume": 0.18,\n    "soundtracks": []\n  },\n  "test": false,\n  "visibility": "private"\n}\n'

xxxxxxxxxx

{\n  "callbackId": "string",\n  "createdAt": 0,\n  "ctaSettings": {\n    "label": [\n      "Learn More",\n      "Sign up"\n    ],\n    "url": [\n      "https://example.com",\n      "https://signup.example.com"\n    ]\n  },\n  "description": "",\n  "test": false,\n  "download": "string",\n  "duration": "string",\n  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n  "lastUpdatedAt": 0,\n  "status": "complete",\n  "thumbnail": {\n    "image": "string",\n    "gif": "string"\n  },\n  "title": "",\n  "visibility": "private"\n}\n```

Updated 2 months ago