Skip to navigation
Synthesia API referenceLocalization

Get a localization

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

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_….

Response headers

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

Response

Successful Response
idstring

The localization id, prefixed l10n_….

statusenum

queued while the source video is fetched, processing once localization starts, then completed or failed.

Allowed values:
errorobject or null

Why the localization failed. Branch on its code: moderation or processing_error. More codes may be added. Null unless the status is failed.

createdAtdatetime or null
Null until the source video is imported.
donebooleanRead-only

True once status is terminal, whatever the outcome. Poll until it is true, then read status.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error