Synthesia (Independent Publisher) (Preview)
Synthesia STUDIO lets you create one-off videos and test different types of videos before automating the process through the service. Also, Synthesia STUDIO lets you define templates with personalization variables that you can call later through the service.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Troy Taylor |
| Website | https://www.synthesia.io/ |
| Privacy policy | https://www.synthesia.io/terms/privacy-policy |
| Categories | AI;Lifestyle and Entertainment |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create a video |
Creates a video based on the request parameters |
| Create a video from a template |
Create a video based on a template created in Synthesia STUDIO. |
| Delete video |
Delete a video. |
| Get template |
Retrieve the information on a template. In particular, you may use it to find out the variables available for customization. |
| Get video status |
Queries the video status. A video can be in status `in_progress' from 10 minutes up to 40+. Once a video is completed, you will be able to see a download URL that you can use to download the .mp4 file. |
| List templates |
Retrieve a list of all templates in Synthesia STUDIO, as well as the variables that may be provided when using them. |
| List videos |
Retrieve a list of all videos created via the API or STUDIO. |
| Update a video |
Patch the parameters of an existing video. |
Create a video
Creates a video based on the request parameters
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Test
|
test | boolean |
Whether a test. |
|
|
Title
|
title | string |
The title. |
|
|
Description
|
description | string |
The description. |
|
|
Visibility
|
visibility | string |
The visibility. |
|
|
Label
|
label | string |
The label. |
|
|
URL
|
url | string |
The URL address. |
|
|
Callback ID
|
callbackId | string |
The callback identifier. |
|
|
Script Text
|
scriptText | True | string |
The script test. |
|
Script Audio
|
scriptAudio | string |
The script audio. |
|
|
Script Language
|
scriptLanguage | string |
The script language. |
|
|
Avatar
|
avatar | True | string |
The avatar. |
|
Voice
|
voice | string |
The voice. |
|
|
Horizontal Align
|
horizontalAlign | string |
The horizontal align. |
|
|
Scale
|
scale | integer |
The scale. |
|
|
Style
|
style | string |
The style. |
|
|
Background Color
|
backgroundColor | string |
The background color. |
|
|
Seamless
|
seamless | boolean |
Whether seamless. |
|
|
Background
|
background | True | string |
The background. |
|
Short Background Content Match Mode
|
shortBackgroundContentMatchMode | string |
The short background content match mode. |
|
|
Long Background Content Match Mode
|
longBackgroundContentMatchMode | string |
The long background content match mode. |
|
|
Soundtrack
|
soundtrack | string |
The soundtrack. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback ID
|
callbackId | string |
The callback identifier. |
|
Created At
|
createdAt | integer |
When created at. |
|
Label
|
ctaSettings.label | string |
The label. |
|
URL
|
ctaSettings.url | string |
The URL address. |
|
Description
|
description | string |
The description. |
|
ID
|
id | string |
The identifier. |
|
Last Updated At
|
lastUpdatedAt | integer |
When last updated at. |
|
Status
|
status | string |
The status. |
|
Title
|
title | string |
The title. |
|
Visibility
|
visibility | string |
The visibility. |
Create a video from a template
Create a video based on a template created in Synthesia STUDIO.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Title
|
title | string |
The title. |
|
|
Description
|
description | string |
The description. |
|
|
Visibility
|
visibility | string |
The visibility. |
|
|
Template ID
|
templateId | True | string |
The template identifier. |
|
Name
|
name | string |
The name. |
|
|
Test
|
test | boolean |
Whether a test. |
|
|
Callback ID
|
callbackId | string |
The callback identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | integer |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Last Updated At
|
lastUpdatedAt | integer |
When last updated at. |
|
Status
|
status | string |
The status. |
|
Title
|
title | string |
The title. |
|
Visibility
|
visibility | string |
The visibility. |
Delete video
Delete a video.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video ID
|
video_id | True | string |
The video identifier. |
Returns
- response
- string
Get template
Retrieve the information on a template. In particular, you may use it to find out the variables available for customization.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template ID
|
template_id | True | string |
The template identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Created At
|
createdAt | integer |
When created at. |
|
ID
|
id | string |
The identifier. |
|
Last Updated At
|
lastUpdatedAt | integer |
When last updated at. |
|
Title
|
title | string |
The title. |
|
Variables
|
variables | array of object |
Get video status
Queries the video status. A video can be in status `in_progress' from 10 minutes up to 40+. Once a video is completed, you will be able to see a download URL that you can use to download the .mp4 file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video ID
|
video_id | True | string |
The video identifier. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback ID
|
callbackId | string |
The callback identifier. |
|
Created At
|
createdAt | integer |
When created at. |
|
Label
|
ctaSettings.label | string |
The label. |
|
URL
|
ctaSettings.url | string |
The URL address. |
|
Description
|
description | string |
The description. |
|
Download
|
download | string |
The download. |
|
Duration
|
duration | string |
The duration. |
|
ID
|
id | string |
The identifier. |
|
Last Updated At
|
lastUpdatedAt | integer |
When last updated at. |
|
Status
|
status | string |
The status. |
|
Title
|
title | string |
The title. |
|
Visibility
|
visibility | string |
The visibility. |
List templates
Retrieve a list of all templates in Synthesia STUDIO, as well as the variables that may be provided when using them.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The page offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Next Offset
|
nextOffset | integer |
The next offset. |
|
Templates
|
templates | array of object | |
|
Created At
|
templates.createdAt | integer |
When created at. |
|
ID
|
templates.id | string |
The identifier. |
|
Last Updated At
|
templates.lastUpdatedAt | integer |
When last updated at. |
|
Title
|
templates.title | string |
The title. |
|
Variables
|
templates.variables | array of object | |
|
ID
|
templates.variables.id | string |
The identifier. |
|
Label
|
templates.variables.label | string |
The label. |
|
Type
|
templates.variables.type | string |
The type. |
List videos
Retrieve a list of all videos created via the API or STUDIO.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The limit. |
|
|
Offset
|
offset | integer |
The page offset. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Videos
|
videos | array of object | |
|
Callback ID
|
videos.callbackId | string |
The callback identifier. |
|
Created At
|
videos.createdAt | integer |
When created at. |
|
Label
|
videos.ctaSettings.label | string |
The label. |
|
URL
|
videos.ctaSettings.url | string |
The URL address. |
|
Description
|
videos.description | string |
The description. |
|
Download
|
videos.download | string |
The download. |
|
Duration
|
videos.duration | string |
The duration. |
|
ID
|
videos.id | string |
The identifier. |
|
Last Updated At
|
videos.lastUpdatedAt | integer |
When last updated at. |
|
Status
|
videos.status | string |
The status. |
|
Title
|
videos.title | string |
The title. |
|
Visibility
|
videos.visibility | string |
The visibility. |
Update a video
Patch the parameters of an existing video.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Video ID
|
video_id | True | string |
The video identifier. |
|
Title
|
title | string |
The title. |
|
|
Description
|
description | string |
The description. |
|
|
Label
|
label | string |
The label. |
|
|
URL
|
url | string |
The URL address. |
|
|
Visibility
|
visibility | string |
The visibility. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Callback ID
|
callbackId | string |
The callback identifier. |
|
Created At
|
createdAt | integer |
When created at. |
|
Label
|
ctaSettings.label | string |
The label. |
|
URL
|
ctaSettings.url | string |
The URL address. |
|
Description
|
description | string |
The description. |
|
Download
|
download | string |
The download. |
|
Duration
|
duration | string |
The duration. |
|
ID
|
id | string |
The identifier. |
|
Last Updated At
|
lastUpdatedAt | integer |
When last updated at. |
|
Status
|
status | string |
The status. |
|
Title
|
title | string |
The title. |
|
Visibility
|
visibility | string |
The visibility. |
Definitions
string
This is the basic data type 'string'.