• Supported service: tts
  • Key: aws_tts
  • Integrated: No. See BYO Keys for more info.

Service options

aws_access_key_id
string
required

Your AWS Access Key ID.

{
  "service_options": {
    "aws_tts": {
      "aws_access_key_id": "$YOUR_AWS_ACCESS_KEY_ID"
    }
  }
}
region
string
required

Your AWS region.

{
  "service_options": {
    "aws_tts": {
      "region": "us-west-2"
    }
  }
}
voice
string
default: "Joanna"

Initialize the voice for the TTS service. Select any voice from the available AWS Polly TTS voices.

{
  "service_options": {
    "aws_tts": {
      "voice": "Amy"
    }
  }
}
sample_rate
integer
default: "24000"

The audio output sample rate in Hz for the TTS audio.

The sample rate must be one of these values: 8000, 16000, 22050, 24000, 44100, 48000.

{
  "service_options": {
    "aws_tts": {
      "sample_rate": 24000
    }
  }
}

Configuration options

voice
string
default: "Joanna"

The voice you want your TTS service to use. Select any voice from the available AWS Polly TTS voices.

Note: your voice, engine, and language options must be compatible.

{
  "name": "voice",
  "value": "Amy"
}
engine
string

The engine you want your TTS service to use. Select any engine from the available AWS Polly TTS engines.

Note: your voice, engine, and language options must be compatible.

{
  "name": "engine",
  "value": "neural"
}
language
string
default: "en-US"

The language you the TTS service to use. Select any language from the available AWS Polly TTS languages.

Note: your voice, engine, and language options must be compatible.

{
  "name": "language",
  "value": "en-GB"
}
pitch
string

The pitch of the voice. Learn more about using pitch with AWS Polly here.

{
  "name": "pitch",
  "value": "medium"
}
rate
string

The rate of the voice. Learn more about using rate with AWS Polly here.

{
  "name": "rate",
  "value": "medium"
}
volume
string

The volume of the voice. Learn more about using volume with AWS Polly here.

{
  "name": "volume",
  "value": "loud"
}
text_filter
object

Control whether the TTS service filters out markdown, code blocks, or tables from its output.

Basic markdown filtering is enabled by default. Enable code and table filtering as needed. Filtering code and tables can help the TTS avoid mistakes.

{
  "name": "text_filter",
  "value": {
    "enable_text_filter": true,
    "filter_code": true,
    "filter_tables": true
  }
}