--- updatedAt: 2026-09-10T15:50:00.000Z agentTools: projectIndex: https://docs.synthesia.io/llms.txt --- # Add locales to a dubbing project (original imported video) Add the passed target locales to a dubbing project (original imported video). If a target locale is already added, it will be skipped. # OpenAPI definition ```json { "info": { "description": "Synthesia public API endpoints", "title": "Synthesia API", "version": "2.0.0" }, "servers": [ { "url": "https://api.synthesia.io", "description": "Synthesia public API URL." } ], "paths": { "/v2/dubbing/{dubbing_project_id}": { "put": { "summary": "Add locales to a dubbing project (original imported video)", "description": "Add the passed target locales to a dubbing project (original imported video). If a target locale is already added, it will be skipped.", "tags": [ "Dubbing" ], "security": [ { "api_key": [] } ], "parameters": [ { "in": "path", "name": "dubbing_project_id", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "UUID of the dubbing project (original imported video)" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLocalesToDubbingProjectRequest" } } } }, "responses": { "202": { "description": "Successfully scheduled dubbing for provided locales.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLocalesToDubbingProjectResponse" } } } }, "204": { "description": "All requested locales were already added." }, "400": { "description": "Bad Request. Invalid imported video or locales.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - Wrong API key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found - Imported video not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Unexpected Server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "openapi": "3.0.2", "components": { "schemas": { "DubbingOutputLanguage": { "enum": [ "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", "eu", "bn", "bs", "bg", "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", "fil", "fi", "fr", "fr-BE", "fr-CA", "fr-FR", "fr-CH", "gl", "ka", "de", "de-AT", "de-DE", "de-CH", "el", "gu", "he", "hi", "hu", "is", "id", "ga", "it", "ja", "jw", "kn", "kk", "km", "ko", "lo", "lv", "lt", "mk", "ms", "ml", "mt", "mr", "mn", "ne", "no", "nb", "nn", "or", "pa", "ps", "fa", "pl", "pt", "pt-BR", "pt-PT", "ro", "ru", "sr", "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", "ta", "ta-IN", "ta-SG", "ta-LK", "te", "th", "tr", "uk", "ur", "uz", "vi", "cy", "zu" ], "title": "DubbingOutputLanguage", "type": "string" }, "AddLocalesToDubbingProjectRequest": { "properties": { "targetLanguages": { "description": "The languages to dub the source media asset to.", "example": [ "es-ES", "fr-FR" ], "items": { "$ref": "#/components/schemas/DubbingOutputLanguage" }, "title": "Targetlanguages", "type": "array" }, "lipsyncEnabled": { "default": false, "description": "Whether to enable lipsync for the dubbed video.", "example": true, "title": "Lipsyncenabled", "type": "boolean" }, "videoDuration": { "default": "adaptive", "description": "The duration of the video to create.", "enum": [ "adaptive", "original" ], "example": "adaptive", "title": "Videoduration", "type": "string" }, "visibility": { "default": "private", "description": "The visibility of the dubbed video.", "enum": [ "private", "public" ], "example": "private", "title": "Visibility", "type": "string" } }, "required": [ "targetLanguages" ], "title": "AddLocalesToDubbingProjectRequest", "type": "object" }, "DubbedVideosApiError": { "properties": { "error": { "default": null, "description": "The error type.", "title": "Error", "type": "string", "nullable": true }, "language": { "default": null, "description": "The language of the error.", "title": "Language", "type": "string", "nullable": true } }, "title": "DubbedVideosApiError", "type": "object" }, "PublicApiImportedAndDubbedVideosErrorCode": { "enum": [ "moderation", "video_duration_limit_reached", "invalid_target_language", "processing_error" ], "title": "PublicApiImportedAndDubbedVideosErrorCode", "type": "string" }, "_DubbedAssetCaptions": { "properties": { "srt": { "default": null, "description": "A time-limited URL which may be used to download the video captions in srt format.", "title": "Srt", "type": "string", "nullable": true }, "vtt": { "default": null, "description": "A time-limited URL which may be used to download the video captions in vtt format.", "title": "Vtt", "type": "string", "nullable": true } }, "title": "_DubbedAssetCaptions", "type": "object" }, "_DubbedAssetComplete": { "description": "Dubbed asset complete - full data.", "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "title": { "description": "Title of the video (used on the video's share page).", "title": "Title", "type": "string" }, "description": { "description": "Description of the video (used on the video's share page).", "title": "Description", "type": "string" }, "language": { "$ref": "#/components/schemas/DubbingOutputLanguage", "description": "The language of the dubbed video." }, "status": { "default": "complete", "description": "The status of the dubbed video.", "title": "Status", "type": "string", "enum": [ "complete" ] }, "createdAt": { "default": null, "description": "UNIX timestamp representing the time video was created.", "title": "Createdat", "type": "integer", "nullable": true }, "lastUpdatedAt": { "default": null, "description": "UNIX timestamp representing the time video was last updated.", "title": "Lastupdatedat", "type": "integer", "nullable": true }, "visibility": { "description": "Describes the visibility settings of the video.", "enum": [ "public", "private" ], "title": "Visibility", "type": "string" }, "download": { "description": "A time-limited URL which may be used to download the video.", "title": "Download", "type": "string" }, "thumbnail": { "$ref": "#/components/schemas/_DubbedAssetThumbnail", "description": "A JSON object with time-limited download URLs for the video thumbnail and animated GIF thumbnail." }, "captions": { "$ref": "#/components/schemas/_DubbedAssetCaptions", "description": "A JSON object with time-limited download URLs for the video captions in vtt and srt formats." } }, "required": [ "id", "title", "description", "language", "visibility", "download", "thumbnail", "captions" ], "title": "_DubbedAssetComplete", "type": "object" }, "_DubbedAssetError": { "description": "Dubbed asset error - minimal data + error code.", "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "language": { "$ref": "#/components/schemas/DubbingOutputLanguage", "description": "The language of the dubbed video." }, "status": { "default": "error", "description": "The status of the dubbed video.", "title": "Status", "type": "string", "enum": [ "error" ] }, "errorCode": { "$ref": "#/components/schemas/PublicApiImportedAndDubbedVideosErrorCode", "description": "Some context in case of dubbed video error." } }, "required": [ "id", "language", "errorCode" ], "title": "_DubbedAssetError", "type": "object" }, "_DubbedAssetInProgress": { "description": "Dubbed asset in progress - minimal data.", "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "language": { "$ref": "#/components/schemas/DubbingOutputLanguage", "description": "The language of the dubbed video." }, "status": { "default": "in_progress", "description": "The status of the dubbed video.", "title": "Status", "type": "string", "enum": [ "in_progress" ] } }, "required": [ "id", "language" ], "title": "_DubbedAssetInProgress", "type": "object" }, "_DubbedAssetThumbnail": { "properties": { "image": { "default": null, "description": "A time-limited URL which may be used to download the video thumbnail.", "title": "Image", "type": "string", "nullable": true }, "gif": { "default": null, "description": "A time-limited URL which may be used to download the video animated GIF thumbnail.", "title": "Gif", "type": "string", "nullable": true } }, "title": "_DubbedAssetThumbnail", "type": "object" }, "AddLocalesToDubbingProjectResponse": { "properties": { "dubbedErrors": { "items": { "$ref": "#/components/schemas/DubbedVideosApiError" }, "title": "Dubbederrors", "type": "array" }, "createdDubbedAssets": { "items": { "anyOf": [ { "$ref": "#/components/schemas/_DubbedAssetInProgress" }, { "$ref": "#/components/schemas/_DubbedAssetComplete" }, { "$ref": "#/components/schemas/_DubbedAssetError" } ] }, "readOnly": true, "title": "Createddubbedassets", "type": "array" } }, "required": [ "createdDubbedAssets" ], "title": "AddLocalesToDubbingProjectResponse", "type": "object" }, "Error": { "type": "object", "properties": { "error": { "type": "string" }, "context": { "type": "string" } }, "required": [ "error" ] } }, "securitySchemes": { "api_key": { "type": "apiKey", "in": "header", "name": "Authorization" } } } } ``` # Sibling pages * [Create a dubbing project from an uploaded video asset](https://docs.synthesia.io/reference/create-a-dubbing-project.md) * [Get dubbing project status and videos](https://docs.synthesia.io/reference/get-dubbing-project-status-and-videos.md)