--- title: "GET /translations" method: GET path: "/translations" tags: ["VideoTranslation"] --- # GET /translations `GET /translations` List translation resources. ## Query parameters - `api-version` string, required - `top` integer - `skip` integer - `maxpagesize` integer ## Response `200` The request has succeeded. - PagedTranslation — Paged collection of Translation items - `value` Translation[], required — The Translation items on this page - `id` string, required — Resource ID - `input` TranslationInput, required — Translation input. - `sourceLocale` string — Locale name, for example: en-US - `targetLocale` string, required — Locale name, for example: en-US - `voiceKind` 'PlatformVoice' | 'PersonalVoice', required — TTS voice kind. - `videoFileUrl` string, uri — Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. - `audioFileUrl` string, uri — Translation audio file Azure blob url, .mp3 or .wav file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. - `speakerCount` integer — Number of speakers in the video, if not provided, it will be auto-detected from the video file. - `enableLipSync` boolean — Indicate whether to enable lip sync, if not provided, the default value is false to disable the lip sync. - `subtitleMaxCharCountPerSegment` integer — Subtitle max display character count per segment, if not provided, it will use the language dependent default value. - `exportSubtitleInVideo` boolean — Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. - `autoCreateFirstIteration` boolean — Indicate whether to automatically create the first iteration when creating a translation, if not specified, the default value is false without creating the first iteration automatically. - `inputFileSourceKind` 'AzureStorageBlobManagedIdentity' — Input source kind for the input video, audio or webvtt files. - `inputFileAzureStorageBlobManagedIdentityClientId` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `firstIterationInput` IterationInput — Iteration input. - `webvttFile` WebvttFile — Translation webvtt file. - `url` string, uri, required — Translation webvtt file url. - `kind` 'SourceLocaleSubtitle' | 'TargetLocaleSubtitle' | 'MetadataJson', required — Webvtt file kind. - `speakerCount` integer — Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. - `subtitleMaxCharCountPerSegment` integer — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. - `exportSubtitleInVideo` boolean — Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. - `ttsCustomLexiconFileUrl` string, uri — Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. - `ttsCustomLexiconFileIdInAudioContentCreation` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `enableVideoSpeedAdjustment` boolean — This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. - `enableOcrCorrectionFromSubtitle` boolean — Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. - `exportTargetLocaleAdvancedSubtitleFile` boolean — This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. - `subtitlePrimaryColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleOutlineColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleFontSize` integer — This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. - `enableEmotionalPlatformVoice` 'Auto' | 'Enable' | 'Disable' — Enable emotional platform voice kind. - `adjustWebvttAlignment` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Specify whether to adjust webvtt alignment according to the synthesized audio for the translated text. If true (default), alignment will be adjusted. If false, alignment will not be adjusted. When not specified, the default value is true (provided as null to the API). - `exportAdjustedPromptAudioInWebvtt` boolean — Specify whether to export adjusted prompt audio in webvtt, if not specified, the default value is false. - `subtitleVerticalMargin` integer — Specify subtitle vertical margin, the value range is from 0 to 200, if not specified, the default value is 10. - `adjustBackgroundVolumeMultiplier` number, double — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Adjust the background volume based on the maximum volume with this multiplier factor. The value range is (0, 1], the suggested value is 0.6 if you want to adjust the background volume. If not specified, the original background audio volume will be kept unchanged. - `pushResultToAzureStorageBlobDirUrl` string, uri — Azure storage blob directory URL to push iteration results to. When specified, the API will push the translation results to the specified Azure storage blob directory. - `pushResultToAzureStorageBlobManagedIdentityClientId` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `use24kPromptAudio` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. When this parameter is set to true, the service uses a higher sample rate (24 kHz) prompt audio for voice prompting. If this parameter is not specified or is set to false, the service continues to use 16 kHz prompt audio by default, which generally provides better overall synthesis quality. - `displayName` string — Translation display name. - `description` string — Translation description. - `createdDateTime` string, date-time — The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `expiresDateTime` string, date-time — The timestamp when the translation will be automatically deleted. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `latestIteration` Iteration — Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. - `id` string, required — Resource ID - `input` IterationInput, required — Iteration input. - `webvttFile` WebvttFile — Translation webvtt file. - `url` string, uri, required — Translation webvtt file url. - `kind` 'SourceLocaleSubtitle' | 'TargetLocaleSubtitle' | 'MetadataJson', required — Webvtt file kind. - `speakerCount` integer — Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. - `subtitleMaxCharCountPerSegment` integer — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. - `exportSubtitleInVideo` boolean — Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. - `ttsCustomLexiconFileUrl` string, uri — Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. - `ttsCustomLexiconFileIdInAudioContentCreation` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `enableVideoSpeedAdjustment` boolean — This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. - `enableOcrCorrectionFromSubtitle` boolean — Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. - `exportTargetLocaleAdvancedSubtitleFile` boolean — This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. - `subtitlePrimaryColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleOutlineColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleFontSize` integer — This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. - `enableEmotionalPlatformVoice` 'Auto' | 'Enable' | 'Disable' — Enable emotional platform voice kind. - `adjustWebvttAlignment` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Specify whether to adjust webvtt alignment according to the synthesized audio for the translated text. If true (default), alignment will be adjusted. If false, alignment will not be adjusted. When not specified, the default value is true (provided as null to the API). - `exportAdjustedPromptAudioInWebvtt` boolean — Specify whether to export adjusted prompt audio in webvtt, if not specified, the default value is false. - `subtitleVerticalMargin` integer — Specify subtitle vertical margin, the value range is from 0 to 200, if not specified, the default value is 10. - `adjustBackgroundVolumeMultiplier` number, double — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Adjust the background volume based on the maximum volume with this multiplier factor. The value range is (0, 1], the suggested value is 0.6 if you want to adjust the background volume. If not specified, the original background audio volume will be kept unchanged. - `pushResultToAzureStorageBlobDirUrl` string, uri — Azure storage blob directory URL to push iteration results to. When specified, the API will push the translation results to the specified Azure storage blob directory. - `pushResultToAzureStorageBlobManagedIdentityClientId` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `use24kPromptAudio` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. When this parameter is set to true, the service uses a higher sample rate (24 kHz) prompt audio for voice prompting. If this parameter is not specified or is set to false, the service continues to use 16 kHz prompt audio by default, which generally provides better overall synthesis quality. - `description` string — Iteration description - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled' — Task status. - `failureReason` string — Iteration failure reason - `createdDateTime` string, date-time — The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `lastActionDateTime` string, date-time — The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `result` IterationResult — Iteration result. - `translatedVideoFileUrl` string, uri — Translated video file URL. - `translatedAudioFileUrl` string, uri — Translated audio file URL. - `sourceLocaleSubtitleWebvttFileUrl` string, uri — Source locale subtitle file URL. - `targetLocaleSubtitleWebvttFileUrl` string, uri — Target locale subtitle file URL. - `targetLocaleAdvancedSubtitleFileUrl` string, uri — This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. - `metadataJsonWebvttFileUrl` string, uri — Metadata json webvtt file URL. - `reportFileUrl` string, uri — Report file URL. - `latestSucceededIteration` Iteration — Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. - `id` string, required — Resource ID - `input` IterationInput, required — Iteration input. - `webvttFile` WebvttFile — Translation webvtt file. - `url` string, uri, required — Translation webvtt file url. - `kind` 'SourceLocaleSubtitle' | 'TargetLocaleSubtitle' | 'MetadataJson', required — Webvtt file kind. - `speakerCount` integer — Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. - `subtitleMaxCharCountPerSegment` integer — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. - `exportSubtitleInVideo` boolean — Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. - `ttsCustomLexiconFileUrl` string, uri — Translate with TTS custom lexicon for speech synthesis. Provide the custom lexicon file using either ttsCustomLexiconFileUrl or ttsCustomLexiconFileIdInAudioContentCreation. These parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. - `ttsCustomLexiconFileIdInAudioContentCreation` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `enableVideoSpeedAdjustment` boolean — This parameter allows for the adjustment of video playback speed to ensure better alignment with translated audio. When enabled, the API can slow down or speed up the video to match the timing of the translated audio, providing a more synchronized and seamless viewing experience, if not specified, video speed will not be adjusted. - `enableOcrCorrectionFromSubtitle` boolean — Indicate whether to allow the API to correct the speech recognition (SR) results using the subtitles from the original video file. By leveraging the existing subtitles, the API can enhance the accuracy of the transcribed text, ensuring that the final output is more precise and reliable, if not specified, translation will not do correction from OCR subtitle. - `exportTargetLocaleAdvancedSubtitleFile` boolean — This parameter, when enabled, allows the API to export subtitles in the Advanced SubStation Alpha format. The subtitle file can specify font styles and colors, which helps in addressing character display issues in certain target locales such as Arabic (Ar), Japanese (Ja), Korean (Ko), and Chinese (Ch). By using this parameter, you can ensure that the subtitles are visually appealing and correctly rendered across different languages and regions, if not specified, iteration response will not include advanced subtitle. - `subtitlePrimaryColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleOutlineColor` string — The value should be provided in the format , #, or #, where represents the red component of the color, represents the green component, represents the blue component, represents the alpha component. For example, EBA205 or #EBA205 would set the subtitle color to a specific shade of yellow. - `subtitleFontSize` integer — This parameter specifies the font size of subtitles in the video translation output between 5 and 30, if not specified, it will use the language dependent default value. - `enableEmotionalPlatformVoice` 'Auto' | 'Enable' | 'Disable' — Enable emotional platform voice kind. - `adjustWebvttAlignment` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Specify whether to adjust webvtt alignment according to the synthesized audio for the translated text. If true (default), alignment will be adjusted. If false, alignment will not be adjusted. When not specified, the default value is true (provided as null to the API). - `exportAdjustedPromptAudioInWebvtt` boolean — Specify whether to export adjusted prompt audio in webvtt, if not specified, the default value is false. - `subtitleVerticalMargin` integer — Specify subtitle vertical margin, the value range is from 0 to 200, if not specified, the default value is 10. - `adjustBackgroundVolumeMultiplier` number, double — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. Adjust the background volume based on the maximum volume with this multiplier factor. The value range is (0, 1], the suggested value is 0.6 if you want to adjust the background volume. If not specified, the original background audio volume will be kept unchanged. - `pushResultToAzureStorageBlobDirUrl` string, uri — Azure storage blob directory URL to push iteration results to. When specified, the API will push the translation results to the specified Azure storage blob directory. - `pushResultToAzureStorageBlobManagedIdentityClientId` string — Guid, for example: 8e2da02e-f9b3-4a1c-941f-8da60f16c2e5 - `use24kPromptAudio` boolean — Recommended: Do not set this parameter unless you have specific requirements. The default behavior is optimized for most customers. When this parameter is set to true, the service uses a higher sample rate (24 kHz) prompt audio for voice prompting. If this parameter is not specified or is set to false, the service continues to use 16 kHz prompt audio by default, which generally provides better overall synthesis quality. - `description` string — Iteration description - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled' — Task status. - `failureReason` string — Iteration failure reason - `createdDateTime` string, date-time — The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `lastActionDateTime` string, date-time — The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). - `result` IterationResult — Iteration result. - `translatedVideoFileUrl` string, uri — Translated video file URL. - `translatedAudioFileUrl` string, uri — Translated audio file URL. - `sourceLocaleSubtitleWebvttFileUrl` string, uri — Source locale subtitle file URL. - `targetLocaleSubtitleWebvttFileUrl` string, uri — Target locale subtitle file URL. - `targetLocaleAdvancedSubtitleFileUrl` string, uri — This property provides the URL of the target locale Advanced SubStation Alpha (ASS) subtitle file. It is populated only when exportTargetLocaleAdvancedSubtitleFile is set to true during iteration creation; otherwise, this property will not be included in the response. - `metadataJsonWebvttFileUrl` string, uri — Metadata json webvtt file URL. - `reportFileUrl` string, uri — Report file URL. - `failureReason` string — Translation failure reason - `nextLink` string, uri — The link to the next page of items ## Other responses - `default` — An unexpected error response. --- [API](https://skmtc.net/azure/apis/cognitiveservices-speech-videotranslation.md) · [All operations](https://skmtc.net/azure/apis/cognitiveservices-speech-videotranslation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/cognitiveservices-speech-videotranslation/revisions/2e781a63dbdc/schema)