🔉 Audio Official Documentation

â‹™ Create Speech

Generates audio from the input text.

msg.payload Properties

input string
The text to generate audio for.
model string
One of the available TTS models: tts-1, tts-1-hd or gpt-4o-mini-tts.
voice string
The voice to use when generating the audio. Supported voices are alloy, ash, coral, echo, fable, onyx, nova, sage and shimmer.
instructions string
Control the voice of your generated audio with additional instructions. Does not work with tts-1 or tts-1-hd.
response_format string
The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
speed number
The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.

â‹™ Create Transcription

Transcribes audio into the input language.

msg.payload Properties

file file
Absolute path to the file that's being transcribed, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model string
ID of the model to use.
language string
The language of the input audio.
prompt string
An optional text to guide the model's style or continue a previous audio segment.
response_format string
The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
temperature number
The sampling temperature, between 0 and 1.
timestamp_granularities array
The timestamp granularities to populate for this transcription. response_format must be set to verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment.

â‹™ Create Translation

Translates audio into English.

msg.payload Properties

file file
Absolute path to the file that's being translated, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model
ID of the model to use.
prompt string
An optional text to guide the model's style or continue a previous audio segment.
response_format string
The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.
temperature number
The sampling temperature, between 0 and 1.