Skip to main content

Amazon Polly (Beta)

Amazon provides natural-sounding text-to-speech with customizable voice instructions and multiple voice options.

Sample configuration

The following example shows a starting tts parameter configuration you can use when you Start a conversational AI agent.


_10
"tts": {
_10
"vendor": "amazon",
_10
"params": {
_10
"aws_access_key_id": "<AWS_TTS_ACCESS_KEY_ID>",
_10
"aws_secret_access_key": "<AWS_TTS_SECRET_ACCESS_KEY>",
_10
"region_name": "<AWS_TTS_REGION>",
_10
"voice": "Joanna",
_10
"engine": "neural"
_10
}
_10
}

caution

The parameters listed on this page are validated for use with Conversational AI Engine. To avoid unpredictable behavior, Agora strongly recommends using only the supported parameters. For a complete reference, consult the Amazon Polly documentation.

Key parameters

paramsrequired
  • aws_access_key_id stringrequired

    The AWS access key ID used for authentication. Get your access key from the AWS IAM Console.

  • aws_secret_access_key stringrequired

    The AWS secret access key used for authentication. Get your secret key from the AWS IAM Console.

  • region_name stringrequired

    The AWS region where the Polly service is hosted, for example, us-east-1, us-west-2, or eu-west-1. See AWS regions for available regions.

  • voice stringrequired

    The voice ID to use for speech synthesis, for example, Joanna, Matthew, or Ivy. See available voices for supported voice IDs.

  • engine stringrequired

    The engine type to use for speech synthesis. Supported values: standard, neural, long-form, generative. See engine documentation for details on each engine type.