Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/resources/audio/speech.ts>SpeechCreateParams

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface SpeechCreateParams
import { type SpeechCreateParams } from "https://deno.land/x/openai@v4.28.4/resources/audio/speech.ts";

Properties

input: string

The text to generate audio for. The maximum length is 4096 characters.

model: (string & { }) | "tts-1" | "tts-1-hd"

One of the available TTS models: tts-1 or tts-1-hd

voice:
| "alloy"
| "echo"
| "fable"
| "onyx"
| "nova"
| "shimmer"

The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer. Previews of the voices are available in the Text to speech guide.

optional
response_format:
| "mp3"
| "opus"
| "aac"
| "flac"
| "pcm"
| "wav"

The format to return audio in. Supported formats are mp3, opus, aac, flac, pcm, and wav.

The pcm audio format, similar to wav but without a header, utilizes a 24kHz sample rate, mono channel, and 16-bit depth in signed little-endian format.

optional
speed: number

The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.