Make Synthesia AI videos: create from scripts or templates, translate and dub them, and read videos, templates and audit logs.
Explore 19 workflow actions for Synthesia, including account permissions and operation limits.
11 read actions8 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add locales to a dubbing project
Write
Add the passed target locales to a dubbing project (original imported video). If a target locale is already added, it will be skipped.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a dubbing project from an uploaded video asset
Write
Use this endpoint to create a dubbing project from an uploaded video asset. Currently only S3 signed URLs are supported (using other URLs will return a 501 error).
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a video
Write
Create a video within your Synthesia account. To get started on this endpoint check the API Quickstart guide.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a video from a template
Write
Create a video based on a template created in Synthesia.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a video
Write
Delete a video.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a webhook
Write
Delete a webhook.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get dubbing project status and videos
Read
Retrieve the status of a dubbing project and its dubbed videos.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Get supported languages for translations
Read
Get a list of supported languages for translations.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Get user media asset
Read
Retrieves a user uploaded media asset by its ID.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Get video translations of a given root video id
Read
Returns the translation status for each language associated with the given studio video.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
List templates
Read
Use the List templates endpoint to get an overview of all templates in Synthesia STUDIO, as well as the variables that may be provided when using them.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
List videos
Read
You can use the List videos endpoint to get an overview of all videos created via the API or STUDIO.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Query audit log events
Read
Retrieve paginated audit log events for a workspace or an organization. Exactly one of workspaceId or organizationId must be provided.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Retrieve a template
Read
You can use Retrieve a template endpoint to pull information on a template. In particular, you may use it to find out the variables available for customisation.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Retrieve a video
Read
You can use Retrieve a video endpoint to pull for the video status.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Retrieve XLIFF content for a video
Read
You can use Retrieve XLIFF content endpoint to pull the XLIFF specification for a given video containing all the text content (script, chapters, text elements).
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Search audit log events (Advanced)
Read
Advanced search endpoint for audit log events with complex filter criteria.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
Start/Update a video translation
Write
Kick off TranslateVideoWorkflow for each requested target language.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a video
Write
Use the Update a video endpoint to make the video public and accessible via the share page or update its title and description.
Permissions and limits
Account permissions
A Synthesia API key (some calls need a key with the matching scope)
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Synthesia. A saved workflow is not a completed provider action.