---
title: "PUT /batchsyntheses/{id}"
method: PUT
path: "/batchsyntheses/{id}"
tags: ["BatchSynthesis"]
---

# PUT /batchsyntheses/{id}

`PUT /batchsyntheses/{id}`

Creates a batch synthesis job, the max allowed payload content length is 500KB.

## Path parameters

- `id` string, required

## Query parameters

- `api-version` string, required

## Headers

- `Operation-Id` string

## Request body

- BatchSynthesis — Batch synthesis task.
  - `inputKind` 'PlainText' | 'SSML', required — Input kind.
  - `inputs` BatchSynthesisInput[] — Text or SSML inputs, it's allowed up to 1000 items.
    - `content` string, required — Input content. It could be SSML or plain text.
  - `synthesisConfig` BatchSynthesisConfig — Text-to-speech configuration for plain text input.
    - `voice` string, required — Voice name for PlainText input. You can find platform voice list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
    - `style` string — Style name for PlainText input.
    - `rate` string — Speaking rate for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
    - `pitch` string — Pitch for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
    - `volume` string — Volume for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
  - `customVoices` object — The custom voice map of voice name and deployment ID .
  - `properties` BatchSynthesisProperties — Detailed properties of batch synthesis task.
    - `timeToLiveInHours` integer — How long the batch task will be kept in the system after it has completed. Once the batch task reaches the time to live after completion (succeeded or failed) it will be automatically deleted. The longest supported duration is 744 hours (31 days). The default value is 744 hours.
    - `destinationContainerUrl` string, uri — The requested destination container. It is an URL with Service adhoc SAS to a writeable container in Azure Blob storage.
    - `destinationPath` string — The destination path in destination container, default to null, it only works when "DestinationContainerUrl" is specified, the final path prefix of outputs should be {DestinationPath}/{TaskId}/, or {TaskId} if not specified.
    - `sizeInBytes` integer — The generated video size in bytes.
    - `succeededCount` integer — The number of succeeded videos.
    - `failedCount` integer — The number of failed videos.
    - `durationInMilliseconds` integer — The generated video duration in milliseconds.
    - `billingDetails` BatchSynthesisBillingDetails — Batch synthesis billing details.
      - `neuralCharacters` integer — The number of billable characters for prebuilt neural voices in the input file.
      - `customNeuralCharacters` integer — The number of billable characters for custom neural voices in the input file.
      - `aoaiCharacters` integer — The number of billable characters for AOAI voices in the input file.
      - `aoaiHDCharacters` integer — The number of billable characters for AOAI HD voices in the input file.
      - `talkingAvatarDurationSeconds` integer — The duration of the talking avatar generated video.
    - `error` BatchSynthesisError — Batch Synthesis Error.
      - `code` string — Top level error code
      - `message` string — Error message
  - `avatarConfig` BatchAvatarConfig, required — Avatar configuration.
    - `talkingAvatarCharacter` string, required — The talking avatar character name. e.g., Lisa.
    - `talkingAvatarStyle` string — The talking avatar character style. e.g., casual-sitting.
    - `videoFormat` string — The output video format.
    - `videoCodec` string — The output video codec.
    - `subtitleType` string — The talking avatar subtitle type.
    - `backgroundColor` string — The talking avatar background color.
    - `backgroundImage` string — The talking avatar background image.
    - `avatarPosition` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `avatarSize` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `resolution` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `videoCrop` BatchAvatarVideoCropDefinition — Only keep the region defined by this object in original Avatar output video.
      - `topLeft` BatchAvatarCoordinateDefinition, required — Coordinate definition
        - `x` number, double — Gets or sets the x-axis.
        - `y` number, double — Gets or sets the y-axis.
      - `bottomRight` BatchAvatarCoordinateDefinition, required — Coordinate definition
        - `x` number, double — Gets or sets the x-axis.
        - `y` number, double — Gets or sets the y-axis.
    - `bitrateKbps` integer — The bitrate of video output settings for talking avatar.
    - `customized` boolean — Whether the avatar character is a custom avatar or not.
  - `outputs` BatchSynthesisOutputs — Batch Synthesis output.
    - `result` string — sas url of the result file. It would be relative path when "destinationContainerUrl" is specified.
    - `summary` string — Job summary file path will be provided here.
  - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' — Status of a resource.
  - `lastActionDateTime` string, date-time — The time-stamp when the current status was entered.
  - `id` string — Resource id
  - `description` string — The description of the batch synthesis task.
  - `createdDateTime` string, date-time — The time-stamp when the object was created.

## Response `201`

Created

- BatchSynthesis — Batch synthesis task.
  - `inputKind` 'PlainText' | 'SSML', required — Input kind.
  - `inputs` BatchSynthesisInput[] — Text or SSML inputs, it's allowed up to 1000 items.
    - `content` string, required — Input content. It could be SSML or plain text.
  - `synthesisConfig` BatchSynthesisConfig — Text-to-speech configuration for plain text input.
    - `voice` string, required — Voice name for PlainText input. You can find platform voice list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
    - `style` string — Style name for PlainText input.
    - `rate` string — Speaking rate for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
    - `pitch` string — Pitch for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
    - `volume` string — Volume for PlainText input. For supported values, see https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
  - `customVoices` object — The custom voice map of voice name and deployment ID .
  - `properties` BatchSynthesisProperties — Detailed properties of batch synthesis task.
    - `timeToLiveInHours` integer — How long the batch task will be kept in the system after it has completed. Once the batch task reaches the time to live after completion (succeeded or failed) it will be automatically deleted. The longest supported duration is 744 hours (31 days). The default value is 744 hours.
    - `destinationContainerUrl` string, uri — The requested destination container. It is an URL with Service adhoc SAS to a writeable container in Azure Blob storage.
    - `destinationPath` string — The destination path in destination container, default to null, it only works when "DestinationContainerUrl" is specified, the final path prefix of outputs should be {DestinationPath}/{TaskId}/, or {TaskId} if not specified.
    - `sizeInBytes` integer — The generated video size in bytes.
    - `succeededCount` integer — The number of succeeded videos.
    - `failedCount` integer — The number of failed videos.
    - `durationInMilliseconds` integer — The generated video duration in milliseconds.
    - `billingDetails` BatchSynthesisBillingDetails — Batch synthesis billing details.
      - `neuralCharacters` integer — The number of billable characters for prebuilt neural voices in the input file.
      - `customNeuralCharacters` integer — The number of billable characters for custom neural voices in the input file.
      - `aoaiCharacters` integer — The number of billable characters for AOAI voices in the input file.
      - `aoaiHDCharacters` integer — The number of billable characters for AOAI HD voices in the input file.
      - `talkingAvatarDurationSeconds` integer — The duration of the talking avatar generated video.
    - `error` BatchSynthesisError — Batch Synthesis Error.
      - `code` string — Top level error code
      - `message` string — Error message
  - `avatarConfig` BatchAvatarConfig, required — Avatar configuration.
    - `talkingAvatarCharacter` string, required — The talking avatar character name. e.g., Lisa.
    - `talkingAvatarStyle` string — The talking avatar character style. e.g., casual-sitting.
    - `videoFormat` string — The output video format.
    - `videoCodec` string — The output video codec.
    - `subtitleType` string — The talking avatar subtitle type.
    - `backgroundColor` string — The talking avatar background color.
    - `backgroundImage` string — The talking avatar background image.
    - `avatarPosition` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `avatarSize` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `resolution` BatchAvatarCoordinateDefinition — Coordinate definition
      - `x` number, double — Gets or sets the x-axis.
      - `y` number, double — Gets or sets the y-axis.
    - `videoCrop` BatchAvatarVideoCropDefinition — Only keep the region defined by this object in original Avatar output video.
      - `topLeft` BatchAvatarCoordinateDefinition, required — Coordinate definition
        - `x` number, double — Gets or sets the x-axis.
        - `y` number, double — Gets or sets the y-axis.
      - `bottomRight` BatchAvatarCoordinateDefinition, required — Coordinate definition
        - `x` number, double — Gets or sets the x-axis.
        - `y` number, double — Gets or sets the y-axis.
    - `bitrateKbps` integer — The bitrate of video output settings for talking avatar.
    - `customized` boolean — Whether the avatar character is a custom avatar or not.
  - `outputs` BatchSynthesisOutputs — Batch Synthesis output.
    - `result` string — sas url of the result file. It would be relative path when "destinationContainerUrl" is specified.
    - `summary` string — Job summary file path will be provided here.
  - `status` 'NotStarted' | 'Running' | 'Succeeded' | 'Failed' — Status of a resource.
  - `lastActionDateTime` string, date-time — The time-stamp when the current status was entered.
  - `id` string — Resource id
  - `description` string — The description of the batch synthesis task.
  - `createdDateTime` string, date-time — The time-stamp when the object was created.

## Other responses

- `default` — An error occurred.

---

[API](https://skmtc.dev/azure/apis/cognitiveservices-speech-batchavatar.md) · [All operations](https://skmtc.dev/azure/apis/cognitiveservices-speech-batchavatar/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/cognitiveservices-speech-batchavatar/revisions/7b51fcfc9d4a/schema)