Overview
SupportedLocale values follow the pattern language_COUNTRY where language is lowercase (ISO 639-1) and COUNTRY is uppercase (ISO 3166-1 alpha-2).
- Examples:
en_US,ko_KR,ja_JP,zh_CN,es_ES,fr_FR - Used by fields like
transcribeLocale,translateLocale, andsummaryLocale.
If a locale is not specified for a field, it may be
null.Supported List
TheSupportedLocale enum only contains the values below. auto is not part of this enum. Automatic detection only applies when you omit transcriptLocaleHints in a Create Voice File Job request (POST /v1/external/voice-file/jobs family) — omitting it detects the language from the audio, rather than sending the string "auto" as a value. The response fields transcribeLocale, translateLocale, and summaryLocale are not values you set on the request; they report the locale actually used after processing. Document generation (GenerateNoteDocumentRequest.locale) does not support automatic detection, so one of the values below must be specified explicitly.
de_DE– German (Germany)en_US– English (United States)es_ES– Spanish (Spain)fr_FR– French (France)hi_IN– Hindi (India)id_ID– Indonesian (Indonesia)it_IT– Italian (Italy)ja_JP– Japanese (Japan)ko_KR– Korean (Korea)ms_MY– Malay (Malaysia)ru_RU– Russian (Russia)sv_SE– Swedish (Sweden)th_TH– Thai (Thailand)tr_TR– Turkish (Turkey)uk_UA– Ukrainian (Ukraine)vi_VN– Vietnamese (Vietnam)zh_CN– Chinese (Simplified, China)
Guidelines
transcribeLocale,translateLocale, andsummaryLocaleare read-only fields that report the locale actually used, returned in the response. They are not request parameters for choosing a locale.- To specify a locale on a request, use the field each endpoint defines. For example, use
transcriptLocaleHintswhen creating a Voice File Job (omit it to auto-detect from the audio), andGenerateNoteDocumentRequest.localewhen generating a document.