Videos describe the content that you've created with Synthesia. Using the API, you're able to generate new videos either from scratch or using one of your existing Synthesia templates.
The Video object contains the necessary information for interacting with your content. Crucially, the video status describes the processing status and governs the availability of some of the other object attributes.
| Object Keys | Type | Description |
|---|---|---|
| id | String | Unique identifier for the video. |
| title | String | Title of the video (used on the video's share page). |
| description | String | Description of the video (used on the video's share page). |
| ctaSettings | Object | Settings for a call-to-action button. |
| ctaSettings.label | String | Label for a call-to-action button. |
| ctaSettings.url | String | URL to navigate to, when the call-to-action button is clicked. |
| visibility | String | Describes the private settings of the video:
|
| status | String | Describes the processing status of the video:
|
| download | String | A time-limited URL which may be used to download the video.This field is only available if the video status is complete. |
| duration | String | Duration of the video.This field is only available if the video status is complete. |
| callbackId | String | Arbitrary metadata set for the video when creating the video. |
| createdAt | Integer | UNIX timestamp representing the time video was created. |
| lastUpdatedAt | Integer | UNIX timestamp representing the time video was last updated. |