audio_speech_request {oaii}

API audio: text to speech request

Description

Generates audio from the input text. To get more details, visit https://platform.openai.com/docs/api-reference/audio/createSpeech https://platform.openai.com/docs/guides/speech-to-text

Usage

audio_speech_request(
  model,
  input,
  voice,
  response_format = NULL,
  speed = NULL,
  api_key = api_get_key()
)

Arguments

model

string, one of the available TTS models: 'tts-1' or 'tts-1-hd'

input

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

voice

string, 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 - https://platform.openai.com/docs/guides/text-to-speech/voice-options

response_format

string, the format to audio in. Supported formats are mp3 (default), opus, aac, and flac

speed

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

api_key

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

Value

content of the httr response object or SimpleError (conditions) enhanced with two additional fields: 'status_code' (response$status_code) and 'message_long' (built on response content)

Examples

## Not run: 
res_content <- audio_speech_request(
  "tts-1",
  "When the power of love overcomes the love of power, the world will know peace.",
  "nova"
)
if (!is_error(res_content)) {
  writeBin(res_content, "peace.mp3")
}

## End(Not run)