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 STUDIO 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 | Description |
|---|---|
| id | Type: String Unique identifier for the video. |
| title | Type: String Title of the video (used on the video's share page). |
| description | Type: String Description of the video (used on the video's share page). |
| 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. |
| visibility | Type: String Describes the private settings of the video. - If public, the video's share page is active.- If private, the video's share page is not active; visitors will receive a 404 Not Found response. |
| status | Type: String Describes the processing status of the video. - in_progress: the video is being processed.- complete: the video was processed successfully.- error: an error occurred during processing.- rejected: the video was rejected during moderation due to inappropriate content. |
| download | Type: 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 | Type: String Duration of the video. This field is only available if the video status is complete. |
| callbackId | Type: String Arbitrary metadata set for the video when creating the video. |
| createdAt | Type: Integer UNIX timestamp representing the time video was created. |
| lastUpdatedAt | Type: Integer UNIX timestamp representing the time video was last updated. |
{
"id": "1234-...",
"title": "Hello, World!",
"description": "This is my first synthetic video, made with the Synthesia API!",
"ctaSettings": { "label": "Click me!", "url": "https://www.synthesia.io" },
"visibility": "private",
"status": "complete",
"download": "https://...",
"duration": "0:00:59.000000",
"callbackId": "[email protected]",
"createdAt": 1602512112,
"lastUpdatedAt": 1602512112
}