Add locales to a localization

curl -X PUT https://developers.synthesia.io/api/localizations/localization_id/locales \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "locales": [
    {
      "language": "es-ES",
      "generate": true
    }
  ],
  "lipsyncEnabled": true,
  "burnedInCaptionsEnabled": false
}'

{
  "data": [
    {
      "id": "string",
      "status": "queued",
      "error": {
        "type": "string",
        "title": "string",
        "status": 1,
        "code": "string",
        "detail": "string",
        "features": [
          "string"
        ],
        "instance": "string",
        "requestId": "string"
      },
      "videoId": "string",
      "language": "es-ES",
      "mode": "dubbing",
      "visibility": "private",
      "createdAt": "2024-01-15T09:30:00Z",
      "download": "string",
      "thumbnail": {
        "image": "string",
        "gif": "string"
      },
      "captions": {
        "srt": "string",
        "vtt": "string"
      },
      "done": true
    }
  ],
  "nextCursor": "string"
}

Add a locale for each language, and return the requested locales.

202 when new locales were added: poll them until each is done.
200 when every language already had a locale.
A language that already has a locale is skipped, so repeating a request is safe. A failed locale isn’t redone: create a new localization to retry it.
Locales are never removed: a language left out keeps its locale.

Required scope: localization:write (in Studio: Localization (write))

Authentication

AuthorizationBearer

Your Synthesia API key.

Send it as Authorization: Bearer <key>; a bare key also works.
An endpoint that needs a scope names it in its description; Scopes lists them all.
A :write scope also satisfies the same resource’s :read.
Without the scope, the request fails with a 403 insufficient_scope.

Path parameters

localization_idstringRequired

The localization id, prefixed l10n_….

Request

This endpoint expects an object.

localeslist of objectsRequired

One entry per language. A language that already has a locale is skipped.

lipsyncEnabledbooleanOptionalDefaults to true

Whether to lip-sync the localized videos. Lip-sync costs extra credit and needs a plan that includes it: without it, adding locales is refused, and a new localization fails once processed.

burnedInCaptionsEnabledbooleanOptionalDefaults to false

Whether to burn captions into the localized videos.

videoDurationenumOptional

adaptive adjusts the video’s speed to fit the translation; original keeps the source’s duration.

Allowed values:

visibilityenumOptional

Who can view the localized videos.

Allowed values:

Response headers

Request-IdstringOptional

The id of this request's audit record. Quote it when reporting a problem.

Response

Every language already had a locale, so nothing new was started. Existing locales come back as they are, including failed ones: a failed locale isn’t redone, so create a new localization to retry it.

datalist of objects

nextCursorstring or null<=512 characters

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

415

Unsupported Media Type Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error

504

Gateway Timeout Error