Translation Operations - Create Translation

Reference

Service:: Azure AI Services

API Version:: 2024-05-20-preview

Creates a translation.

PUT {endpoint}/videotranslation/translations/{translationId}?api-version=2024-05-20-preview

URI Parameters

Name In Required Type Description

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com).
translationId	path	True	string	Translation resource ID. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	The API version to use for this operation.

endpoint

path

True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com).

translationId

path

True

string

Translation resource ID.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

The API version to use for this operation.

Request Header

Name Required Type Description

Operation-Id

True

Name	Required	Type	Description
Operation-Id	True	string	Operation ID. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Operation ID.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Request Body

Name	Required	Type	Description
input	True	TranslationInput	Translation input.
description		string	Translation description.
displayName		string	Translation display name.

Responses

Name	Type	Description
200 OK	Translation	The request has succeeded. Headers Operation-Location: string
201 Created	Translation	The request has succeeded and a new resource has been created as a result. Headers Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

Translation

The request has succeeded.

Headers

Operation-Location: string

201 Created

Translation

The request has succeeded and a new resource has been created as a result.

Headers

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Provide your Speech resource key here.

Type: apiKey
In: header

AADToken

These are the Microsoft identity platform flows.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Examples

Create Translation

Sample request

HTTP

PUT {endpoint}/videotranslation/translations/TranslateMyZhCNVideo?api-version=2024-05-20-preview


{
  "displayName": "hello.mp4",
  "description": "Translate video from en-US to zh-CN.",
  "input": {
    "sourceLocale": "en-US",
    "targetLocale": "zh-CN",
    "voiceKind": "PlatformVoice",
    "videoFileUrl": "https://mystorage.blob.core.windows.net/container1/video.mp4?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx"
  }
}

Sample response

Status code:: 200

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo?api-version=2024-02-01-preview
Operation-Id: Create-TranslateMyZhCNVideo

{
  "id": "TranslateMyZhCNVideo",
  "displayName": "hello.mp4",
  "description": "Translate video from en-US to zh-CN.",
  "input": {
    "sourceLocale": "en-US",
    "targetLocale": "zh-CN",
    "voiceKind": "PlatformVoice",
    "videoFileUrl": "https://mystorage.blob.core.windows.net/container1/video.mp4?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx"
  },
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "latestIteration": {
    "id": "Initial",
    "status": "NotStarted",
    "input": {
      "speakerCount": 3,
      "subtitleMaxCharCountPerSegment": 80,
      "webvttFile": {
        "url": "https://xxx.blob.core.windows.net/container1/myvtt.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
        "kind": "MetadataJson"
      }
    }
  }
}

Status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo?api-version=2024-02-01-preview
Operation-Id: Create-TranslateMyZhCNVideo

{
  "id": "TranslateMyZhCNVideo",
  "description": "Translate video from en-US to zh-CN.",
  "input": {
    "sourceLocale": "en-US",
    "targetLocale": "zh-CN",
    "voiceKind": "PlatformVoice",
    "videoFileUrl": "https://mystorage.blob.core.windows.net/container1/video.mp4?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx"
  },
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "latestIteration": {
    "id": "Initial",
    "status": "NotStarted",
    "input": {
      "speakerCount": 3,
      "subtitleMaxCharCountPerSegment": 80,
      "webvttFile": {
        "url": "https://xxx.blob.core.windows.net/container1/myvtt.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
        "kind": "MetadataJson"
      }
    }
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter.
IterationInput	Iteration input.
IterationResult	Iteration result.
Status	Task status.
Translation	Create translation resource for hosting iterations of translating one video file from source locale to target locale.
TranslationInput	Translation input.
VoiceKind	TTS voice kind.
WebvttFile	Translation webvtt file.
WebvttFileKind	Webvtt file kind.

Azure.Core.Foundations.Error

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Iteration

Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter.

Name	Type	Description
createdDateTime	string	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).
description	string	Iteration description
failureReason	string	Iteration failure reason
id	string	Iteration ID
input	IterationInput	Iteration input.
lastActionDateTime	string	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.
status	Status	Iteration status

IterationInput

Iteration input.

Name	Type	Description
exportSubtitleInVideo	boolean	Export subtitle in video.
speakerCount	integer	Number of speakers in the video.
subtitleMaxCharCountPerSegment	integer	Subtitle max display character count per segment.
webvttFile	WebvttFile	Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation.

IterationResult

Iteration result.

Name	Type	Description
metadataJsonWebvttFileUrl	string	Metadata json webvtt file URL.
reportFileUrl	string	Report file URL.
sourceLocaleSubtitleWebvttFileUrl	string	Source locale subtitle file URL.
targetLocaleSubtitleWebvttFileUrl	string	Target locale subtitle file URL.
translatedVideoFileUrl	string	Translated video file URL.

Status

Task status.

Name	Type	Description
Canceled	string	Cancelled status
Failed	string	Run failed status
NotStarted	string	Not started status
Running	string	Running status
Succeeded	string	Run succeeded status

Translation

Create translation resource for hosting iterations of translating one video file from source locale to target locale.

Name	Type	Description
createdDateTime	string	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).
description	string	Translation description.
displayName	string	Translation display name.
failureReason	string	Translation failure reason
id	string	Translation resource ID.
input	TranslationInput	Translation input.
latestIteration	Iteration	Latest iteration of the translation.
latestSucceededIteration	Iteration	Latest completed iteration of the translation.

TranslationInput

Translation input.

Name	Type	Description
exportSubtitleInVideo	boolean	Export subtitle in video.
sourceLocale	string	The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://zcusa.951200.xyz/azure/ai-services/speech-service/language-support?tabs=tts.
speakerCount	integer	Number of speakers in the video.
subtitleMaxCharCountPerSegment	integer	Subtitle max display character count per segment.
targetLocale	string	The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://zcusa.951200.xyz/azure/ai-services/speech-service/language-support?tabs=tts.
videoFileUrl	string	Translation video file url.
voiceKind	VoiceKind	Translation voice kind.

VoiceKind

TTS voice kind.

Name	Type	Description
PersonalVoice	string	TTS personal voice
PlatformVoice	string	TTS platform voice

WebvttFile

Translation webvtt file.

Name	Type	Description
kind	WebvttFileKind	Translation webvtt file kind.
url	string	Translation webvtt file url.

WebvttFileKind

Webvtt file kind.

Name	Type	Description
MetadataJson	string	Target locale metadata JSON webvtt file
SourceLocaleSubtitle	string	Source locale plain text subtitle webvtt file
TargetLocaleSubtitle	string	Target locale plain text subtitle webvtt file

Share via

Translation Operations - Create Translation

URI Parameters

Request Header

Request Body

Responses

Security

Ocp-Apim-Subscription-Key

AADToken

Scopes

Examples

Create Translation

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

Status

Translation

TranslationInput

VoiceKind

WebvttFile

WebvttFileKind

Additional resources