---
canonical_url: "https://docs.composio.dev/toolkits/synthesia"
markdown_url: "https://docs.composio.dev/toolkits/synthesia.md"
product: "platform"
version: null
last_updated: null
---

# Synthesia

Synthesia creates AI avatar videos, interactive avatars, localized media, and related video assets through its REST APIs.

- **Category:** video & audio
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 37
- **Triggers:** 0
- **Slug:** `SYNTHESIA`
- **Version:** 00000000_00

## Tools

### Add Dubbing Project Locales (Deprecated)

**Slug:** `SYNTHESIA_ADD_DUBBING_PROJECT_LOCALES`

Deprecated: add target-language locales to a legacy dubbing project. Use Add Localization Locales instead with localization_id set to l10n_<dubbing_project_id>. This paid Legacy v2 operation may generate videos or consume credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `visibility` | string ("private" | "public") | No | Visibility of newly generated dubbed videos. |
| `video_duration` | string ("adaptive" | "original") | No | Whether output may adapt duration or must preserve the source duration. |
| `lipsync_enabled` | boolean | No | Whether newly generated dubbed videos use lip synchronization. |
| `target_languages` | array | Yes | Additional target language codes to generate; existing locales are skipped. |
| `dubbing_project_id` | string | Yes | UUID of the original imported video's dubbing project. |
| `burned_in_captions_enabled` | boolean | No | Whether newly generated dubbed videos contain burned-in captions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Localization Locales

**Slug:** `SYNTHESIA_ADD_LOCALIZATION_LOCALES`

Add target-language locales to an existing localization. Existing languages are skipped; generation may consume credits, and lipsync_enabled defaults to true and costs additional credits. Poll returned locales until done is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locales` | array | Yes | Locales to add, one per target language. Existing languages are skipped. |
| `visibility` | string ("private" | "public") | No | Who can view the newly generated localized videos. |
| `video_duration` | string ("adaptive" | "original") | No | Whether output may adapt duration or must preserve the source duration. |
| `lipsync_enabled` | boolean | No | Whether newly generated locale videos use lip synchronization. |
| `localization_id` | string | Yes | Localization ID with the l10n_ prefix. |
| `burned_in_captions_enabled` | boolean | No | Whether newly generated locale videos contain burned-in captions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dubbing Project

**Slug:** `SYNTHESIA_CREATE_DUBBING_PROJECT`

Create an asynchronous dubbing project from an uploaded Synthesia media asset or a deprecated signed S3 URL. This paid Legacy v2 operation may generate videos or consume credits; use the returned asset ID to retrieve status and dubbed videos.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title for the dubbed video project. |
| `visibility` | string ("private" | "public") | No | Visibility of the generated dubbed videos. |
| `video_duration` | string ("adaptive" | "original") | No | Whether generated videos may adapt their duration or preserve the source duration. |
| `lipsync_enabled` | boolean | No | Whether to lip-sync the generated dubbed videos. |
| `source_asset_id` | string | No | Uploaded Synthesia media asset ID to use as the source video. Provide exactly one of source_asset_id or source_video_url. |
| `source_language` | string ("af" | "sq" | "am" | "ar" | "ar-DZ" | "ar-BH" | "ar-EG" | "ar-IQ" | "ar-JO" | "ar-KW" | "ar-LY" | "ar-MA" | "ar-QA" | "ar-SA" | "ar-SY" | "ar-TN" | "ar-AE" | "ar-YE" | "hy" | "as" | "az" | "ba" | "eu" | "be" | "bn" | "bs" | "br" | "bg" | "my" | "ca" | "zh" | "zh-CN" | "zh-HK" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "nl-BE" | "nl-NL" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-HK" | "en-IN" | "en-IE" | "en-KE" | "en-MX" | "en-NZ" | "en-NG" | "en-PH" | "en-SG" | "en-ZA" | "en-TZ" | "en-US" | "et" | "fo" | "fi" | "fr" | "fr-BE" | "fr-CA" | "fr-FR" | "fr-CH" | "gl" | "ka" | "de" | "de-AT" | "de-DE" | "de-CH" | "el" | "gu" | "ht" | "ha" | "haw" | "he" | "hi" | "hu" | "is" | "id" | "it" | "ja" | "jw" | "kn" | "kk" | "km" | "ko" | "lo" | "la" | "lv" | "ln" | "lt" | "lb" | "mk" | "mg" | "ms" | "ml" | "mt" | "mi" | "mr" | "mn" | "ne" | "no" | "nb" | "nn" | "oc" | "pa" | "ps" | "fa" | "pl" | "pt" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sa" | "sr" | "sn" | "sd" | "si" | "sk" | "sl" | "so" | "es" | "es-AR" | "es-BO" | "es-CL" | "es-CO" | "es-CR" | "es-CU" | "es-DO" | "es-EC" | "es-SV" | "es-GQ" | "es-GT" | "es-HN" | "es-LA" | "es-MX" | "es-NI" | "es-PA" | "es-PY" | "es-PE" | "es-PR" | "es-ES" | "es-US" | "es-UY" | "es-VE" | "su" | "sw" | "sv" | "tl" | "tg" | "ta" | "ta-IN" | "ta-SG" | "ta-LK" | "tt" | "te" | "th" | "bo" | "tr" | "tk" | "uk" | "ur" | "uz" | "vi" | "cy" | "yi" | "yo") | No | Language code for the source media asset; required with source_asset_id. |
| `source_video_url` | string | No | Deprecated signed S3 URL to use as the source video. Provide exactly one of source_video_url or source_asset_id. |
| `target_languages` | array | Yes | Language codes into which Synthesia should dub the source video. |
| `burned_in_captions_enabled` | boolean | No | Whether to burn captions into every generated dubbed video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Dubbing Project From File

**Slug:** `SYNTHESIA_CREATE_DUBBING_PROJECT_FROM_FILE`

Upload a video as a new Synthesia asset, then create a dubbing project and dubbed videos from that asset. If dubbing creation fails after the upload, the uploaded asset remains as partial state. This operation requires paid Legacy (v2) access and consumes credits. It is non-idempotent: retries can create duplicate assets and dubbing projects and consume additional credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title for the dubbing project. |
| `video` | object | Yes | MP4 or WebM video to upload and use as the dubbing source. |
| `visibility` | string ("private" | "public") | No | Visibility of the generated dubbed videos. |
| `video_duration` | string ("adaptive" | "original") | No | Whether generated videos may adapt their duration or preserve the source duration. |
| `lipsync_enabled` | boolean | No | Whether to lip-sync the generated dubbed videos. |
| `source_language` | string ("af" | "sq" | "am" | "ar" | "ar-DZ" | "ar-BH" | "ar-EG" | "ar-IQ" | "ar-JO" | "ar-KW" | "ar-LY" | "ar-MA" | "ar-QA" | "ar-SA" | "ar-SY" | "ar-TN" | "ar-AE" | "ar-YE" | "hy" | "as" | "az" | "ba" | "eu" | "be" | "bn" | "bs" | "br" | "bg" | "my" | "ca" | "zh" | "zh-CN" | "zh-HK" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "nl-BE" | "nl-NL" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-HK" | "en-IN" | "en-IE" | "en-KE" | "en-MX" | "en-NZ" | "en-NG" | "en-PH" | "en-SG" | "en-ZA" | "en-TZ" | "en-US" | "et" | "fo" | "fi" | "fr" | "fr-BE" | "fr-CA" | "fr-FR" | "fr-CH" | "gl" | "ka" | "de" | "de-AT" | "de-DE" | "de-CH" | "el" | "gu" | "ht" | "ha" | "haw" | "he" | "hi" | "hu" | "is" | "id" | "it" | "ja" | "jw" | "kn" | "kk" | "km" | "ko" | "lo" | "la" | "lv" | "ln" | "lt" | "lb" | "mk" | "mg" | "ms" | "ml" | "mt" | "mi" | "mr" | "mn" | "ne" | "no" | "nb" | "nn" | "oc" | "pa" | "ps" | "fa" | "pl" | "pt" | "pt-BR" | "pt-PT" | "ro" | "ru" | "sa" | "sr" | "sn" | "sd" | "si" | "sk" | "sl" | "so" | "es" | "es-AR" | "es-BO" | "es-CL" | "es-CO" | "es-CR" | "es-CU" | "es-DO" | "es-EC" | "es-SV" | "es-GQ" | "es-GT" | "es-HN" | "es-LA" | "es-MX" | "es-NI" | "es-PA" | "es-PY" | "es-PE" | "es-PR" | "es-ES" | "es-US" | "es-UY" | "es-VE" | "su" | "sw" | "sv" | "tl" | "tg" | "ta" | "ta-IN" | "ta-SG" | "ta-LK" | "tt" | "te" | "th" | "bo" | "tr" | "tk" | "uk" | "ur" | "uz" | "vi" | "cy" | "yi" | "yo") | Yes | Language code of the source video. |
| `target_languages` | array | Yes | Language codes into which Synthesia should dub the source video. |
| `burned_in_captions_enabled` | boolean | No | Whether to burn captions into every generated dubbed video. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Interactive Avatar

**Slug:** `SYNTHESIA_CREATE_INTERACTIVE_AVATAR`

Create or regenerate an interactive avatar from a Studio avatar; creation and regeneration consume credits. To poll existing generation without regenerating, repeat this action with regenerate=false until done is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_id` | string | Yes | Source Studio avatar ID, matching the av_ prefix format. |
| `regenerate` | boolean | No | Whether to regenerate the interactive avatar when one already exists for the source. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Localization From Media URL

**Slug:** `SYNTHESIA_CREATE_LOCALIZATION_FROM_MEDIA_URL`

Create an asynchronous localization job from a presigned S3 video URL. Generation may consume credits, and lipsync_enabled defaults to true and costs additional credits. Poll Get Localization until done is true.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title for the localization project. |
| `media_url` | string | Yes | Presigned HTTPS S3 URL from which Synthesia can download the source video. |
| `visibility` | string ("private" | "public") | No | Visibility of generated localized videos. |
| `video_duration` | string ("adaptive" | "original") | No | Whether translated output may adapt duration or must preserve the original duration. |
| `lipsync_enabled` | boolean | No | Whether generated locales should use lip synchronization. |
| `source_language` | string | Yes | Source language code, or auto to detect it. |
| `target_languages` | array | Yes | One to 20 target language codes returned by List Localization Languages. |
| `burned_in_captions_enabled` | boolean | No | Whether generated videos should contain burned-in captions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Media Asset

**Slug:** `SYNTHESIA_CREATE_MEDIA_ASSET`

Register a large video asset and return Synthesia's multipart upload instructions. This action does not upload the video bytes to the returned storage destination. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title of the media asset. |
| `content_md5` | string | No | Base64-encoded MD5 digest of the source video, used to verify upload integrity. |
| `content_type` | string ("video/mp4" | "video/webm" | "video/quicktime") | Yes | MIME type of the source video to register. |
| `configuration` | object | Yes | Dubbing configuration to apply while processing the uploaded video. |
| `content_length` | integer | No | Source video size in bytes, used to verify upload integrity. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video

**Slug:** `SYNTHESIA_CREATE_VIDEO`

Create a scripted avatar video. This paid Legacy v2 operation may consume Synthesia credits; use test=true for a watermarked test video when appropriate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `test` | boolean | No | Whether to create a free watermarked test video under Synthesia's test limits. |
| `input` | array | Yes | Ordered scenes that make up the video. |
| `title` | string | No | Video title. |
| `folder_id` | string | No | Studio folder ID in which to create the video. |
| `soundtrack` | string ("corporate" | "inspirational" | "modern" | "urban") | No | Legacy soundtrack selection; Synthesia recommends templates for rich videos. |
| `visibility` | string ("private" | "public") | No | Video visibility. |
| `callback_id` | string | No | Caller correlation identifier returned through callback workflows. |
| `description` | string | No | Video description. |
| `aspect_ratio` | string ("16:9" | "9:16" | "1:1" | "4:5" | "5:4") | No | Output aspect ratio for the video. |
| `cta_settings` | object | No | Call-to-action button settings. |
| `sound_settings` | object | No | Video-level soundtrack configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video From Template

**Slug:** `SYNTHESIA_CREATE_VIDEO_FROM_TEMPLATE`

Create a video from a Studio template and variable values. This paid Legacy v2 operation may consume Synthesia credits; use test=true for a watermarked test video when appropriate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `test` | boolean | No | Whether to create a free watermarked test video under Synthesia's test limits. |
| `title` | string | No | Video title. |
| `folder_id` | string | No | Studio folder ID in which to create the video. |
| `visibility` | string ("private" | "public") | No | Video share-page visibility. |
| `callback_id` | string | No | Caller correlation identifier returned through callback workflows. |
| `description` | string | No | Video description. |
| `template_id` | string | Yes | Template UUID returned by List Templates. |
| `brand_kit_id` | string | No | Brand kit UUID, workspace_default, or no_brand_kit. |
| `cta_settings` | object | No | Call-to-action button settings. |
| `template_data` | object | Yes | Values for the selected template's customizable variables. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `SYNTHESIA_CREATE_WEBHOOK`

Create a webhook subscription for video completion or failure events. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public callback URL to receive webhook events. |
| `events` | array | Yes | Video event types that should be delivered. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Video

**Slug:** `SYNTHESIA_DELETE_VIDEO`

Permanently delete one video. This destructive paid Legacy v2 action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `SYNTHESIA_DELETE_WEBHOOK`

Permanently delete one webhook subscription. This destructive paid Legacy v2 action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Audit Log Events

**Slug:** `SYNTHESIA_EXPORT_AUDIT_LOG_EVENTS`

Export up to 10,000 filtered Synthesia audit events for exactly one workspace or organization as a CSV file. Synthesia truncates larger exports and marks their filenames with _TRUNCATED. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `actions` | array | No | Audit action names to include in the export. |
| `end_date` | integer | No | Return events created on or before this Unix timestamp in seconds. |
| `actor_ids` | array | No | Actor IDs whose events to include in the export. |
| `target_id` | string | No | Return only events for this target resource ID. |
| `start_date` | integer | No | Return events created on or after this Unix timestamp in seconds. |
| `workspace_id` | string | No | Workspace UUID whose events to export. Provide exactly one of workspace_id or organization_id. |
| `organization_id` | string | No | Organization UUID whose events to export. Provide exactly one of organization_id or workspace_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Billing Credits

**Slug:** `SYNTHESIA_GET_BILLING_CREDITS`

Return the workspace billing period and credit balance. This API-key action has no named product-scope requirement.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dubbing Project (Deprecated)

**Slug:** `SYNTHESIA_GET_DUBBING_PROJECT`

Deprecated: get a legacy dubbing project's status, dubbed videos, and errors. For new integrations, use Get Localization with l10n_<dubbing_project_id> for status and List Localization Locales for dubbed videos. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_languages` | array | No | Optional target language codes used to filter the returned dubbed videos. |
| `dubbing_project_id` | string | Yes | UUID of the legacy dubbing project to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Localization

**Slug:** `SYNTHESIA_GET_LOCALIZATION`

Get the import and processing status of one localization. Poll until done is true, then inspect status and error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `localization_id` | string | Yes | Localization ID with the l10n_ prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Media Asset

**Slug:** `SYNTHESIA_GET_MEDIA_ASSET`

Get the upload status and metadata of a registered media asset. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_media_asset_id` | string | Yes | Media asset ID returned by Create Media Asset. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `SYNTHESIA_GET_TEMPLATE`

Get one Studio template and its customizable variables. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | string | Yes | Template ID returned by List Templates. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video

**Slug:** `SYNTHESIA_GET_VIDEO`

Get one video's processing status, metadata, and available download assets. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID returned by a create or list action. |
| `include_rejected` | boolean | No | Return a rejected video record instead of treating it as not found. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Thumbnail

**Slug:** `SYNTHESIA_GET_VIDEO_THUMBNAIL`

Download a video's best available, animated GIF, or JPG thumbnail as one offloaded file. The format defaults to best. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("best" | "gif" | "jpg") | No | Thumbnail format to download. Defaults to 'best', which asks Synthesia for an animated GIF when available and otherwise a JPG. |
| `video_id` | string | Yes | Video ID returned by a create, list, or get video action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video Translations

**Slug:** `SYNTHESIA_GET_VIDEO_TRANSLATIONS`

Get per-language translation status for a root video. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `root_video_id` | string | Yes | Root Studio video UUID whose translations should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Video XLIFF

**Slug:** `SYNTHESIA_GET_VIDEO_XLIFF`

Retrieve a video's script, chapters, and text elements as an XLIFF document. Optionally select a video version and XLIFF 1.2. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `video_id` | string | Yes | Video ID whose text content should be retrieved as XLIFF. |
| `video_version` | integer | No | Specific video version to retrieve; omit to use the current version. |
| `xliff_version` | string | No | Desired XLIFF specification version. Synthesia currently supports 1.2. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `SYNTHESIA_GET_WEBHOOK`

Get a webhook subscription's callback URL, secret, status, and creation and update timestamps by webhook ID. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Webhook ID returned by Create Webhook or List Webhooks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audit Log Events

**Slug:** `SYNTHESIA_LIST_AUDIT_LOG_EVENTS`

List one page of Synthesia audit events for exactly one workspace or organization, with action, actor, target, and Unix-time filters. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum events to return in this page (1-200). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `actions` | array | No | Audit action names to include. |
| `end_date` | integer | No | Return events created before this Unix timestamp in seconds. |
| `actor_ids` | array | No | Actor IDs to include. |
| `target_id` | string | No | Return only events for this target resource ID. |
| `start_date` | integer | No | Return events created on or after this Unix timestamp in seconds. |
| `workspace_id` | string | No | Workspace UUID whose events to list. Provide exactly one of workspace_id or organization_id. |
| `organization_id` | string | No | Organization UUID whose events to list. Provide exactly one of organization_id or workspace_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Localization Languages

**Slug:** `SYNTHESIA_LIST_LOCALIZATION_LANGUAGES`

List one page of languages supported as Synthesia localization dubbing sources or targets. Pass the returned cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum languages to return in this page. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `supports` | string ("dubbing_source" | "dubbing_target") | No | Filter languages by whether they support source or target dubbing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Localization Locales

**Slug:** `SYNTHESIA_LIST_LOCALIZATION_LOCALES`

List one page of localized-language outputs for a Synthesia localization, including processing status and available video assets. Pass the returned cursor to retrieve the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum locales to return in this page (1-100). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `localization_id` | string | Yes | Localization ID with the l10n_ prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `SYNTHESIA_LIST_TEMPLATES`

List one page of Synthesia Studio templates and their customizable variables. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum templates to return in this page (1-100). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `source` | array | No | Template source categories to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Translation Languages

**Slug:** `SYNTHESIA_LIST_TRANSLATION_LANGUAGES`

Return the legacy translation-languages response exactly as Synthesia sends it under raw_response. This paid Legacy v2 action requires an API key with the legacy scope; the provider's published success schema is known to be incorrect.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Videos

**Slug:** `SYNTHESIA_LIST_VIDEOS`

List one page of API and Studio videos. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum videos to return in this page (1-100). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `source` | array | No | Video source categories to include. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `SYNTHESIA_LIST_WEBHOOKS`

List one page of active or deleted webhook subscriptions. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum webhooks to return in this page (1-100). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `deleted` | boolean | No | Whether to list deleted rather than active webhooks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Audit Log Events

**Slug:** `SYNTHESIA_SEARCH_AUDIT_LOG_EVENTS`

Search one page of audit events using advanced JSON-body filters for large filter sets or clients that require JSON. Prefer List Audit Log Events for most use cases. This paid Legacy v2 action requires an API key with the legacy scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum audit events to return in this page (1-200). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `actions` | array | No | Audit action names to include, such as user.authentication.login. |
| `end_date` | integer | No | Inclusive end of the event time range as Unix seconds. |
| `actor_ids` | array | No | Actor IDs whose events should be included. |
| `target_id` | string | No | Target resource ID whose events should be included. |
| `start_date` | integer | No | Inclusive start of the event time range as Unix seconds. |
| `workspace_id` | string | No | Workspace UUID whose events to search. Provide exactly one of workspace_id or organization_id. |
| `organization_id` | string | No | Organization UUID whose events to search. Provide exactly one of organization_id or workspace_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Interactive Avatar Session

**Slug:** `SYNTHESIA_START_INTERACTIVE_AVATAR_SESSION`

Start a live interactive-avatar session in an existing caller-provided LiveKit room. Each running session counts toward the workspace's concurrent session limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `avatar_ids` | array | Yes | Interactive avatar IDs to join to the LiveKit room. |
| `livekit_url` | string | Yes | WebSocket URL of the LiveKit room, beginning with wss://. |
| `livekit_token` | string | Yes | LiveKit participant token that authorizes the session to join the room. Reuse it with the same LiveKit URL when retrying a failed request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Or Update Video Translation

**Slug:** `SYNTHESIA_START_OR_UPDATE_VIDEO_TRANSLATION`

Start missing target-language translations or update the translation set for a Studio video. This paid Legacy v2 operation may generate videos or consume credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `auto_generate` | string ("private" | "public") | No | Visibility for automatically generated translated videos, or null to disable automatic generation. |
| `root_video_id` | string | Yes | Root Studio video UUID whose translations should be started or updated. |
| `target_languages` | array | Yes | Target language codes to create or retain. |
| `translate_script_only` | boolean | No | Whether to translate only the script instead of generating translated videos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Translate Video From XLIFF

**Slug:** `SYNTHESIA_TRANSLATE_VIDEO_FROM_XLIFF`

Create a translated video through Synthesia's manual XLIFF operation. The provider reference exposes no XLIFF input field, request body, or parameters, so this action does not accept caller-supplied translation content. Live provider validation requires an empty JSON object despite generated examples omitting the body. This paid Legacy v2 action requires an API key with the legacy scope.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Video

**Slug:** `SYNTHESIA_UPDATE_VIDEO`

Update a video's title, description, visibility, or call-to-action settings. This paid Legacy v2 operation requires an API key with Legacy (v2) access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Replacement video title. |
| `video_id` | string | Yes | Video ID to update. |
| `visibility` | string ("private" | "public") | No | Replacement video visibility. |
| `description` | string | No | Replacement video description. |
| `cta_settings` | object | No | Replacement call-to-action settings, or null to clear them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Asset

**Slug:** `SYNTHESIA_UPLOAD_ASSET`

Upload an image or video file to Synthesia's Upload API and return the provider's asset metadata, including its identifier when supplied.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Image or video file to upload. |
| `content_type` | string ("image/jpeg" | "image/png" | "image/svg+xml" | "video/mp4" | "video/webm") | Yes | Media type of the file. Synthesia accepts JPEG, PNG, SVG, MP4, and WebM assets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Script Audio

**Slug:** `SYNTHESIA_UPLOAD_SCRIPT_AUDIO`

Upload custom script audio to Synthesia for asynchronous processing. When the response includes an asset ID, check it with Get Media Asset before using it to create a video.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Audio file whose raw bytes should be uploaded as custom script audio. |
| `content_type` | string ("audio/mpeg" | "application/octet-stream") | No | MIME type for the script-audio bytes. Use audio/mpeg for MP3 audio as documented by the endpoint guide; application/octet-stream remains accepted for generic binary clients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
