Constructor Detail

Method Detail

• input

   final String input()

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

• model

   final SpeechModel model()

  One of the available TTS models: tts-1, tts-1-hd, gpt-4o-mini-tts, or gpt-4o-mini-tts-2025-12-15.

• voice

   final SpeechCreateParams.Voice voice()

  The voice to use when generating the audio. Supported built-in voices are alloy, ash, ballad, coral, echo, fable, onyx, nova, sage, shimmer, verse, marin, and cedar. You may also provide a custom voice object with an id, for example { "id": "voice_1234" }. Previews of the voices are available in the Text to speech guide.

• instructions

   final Optional<String> instructions()

  Control the voice of your generated audio with additional instructions. Does not work with tts-1 or tts-1-hd.

• responseFormat

   final Optional<SpeechCreateParams.ResponseFormat> responseFormat()

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

• speed

   final Optional<Double> speed()

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

• streamFormat

   final Optional<SpeechCreateParams.StreamFormat> streamFormat()

  The format to stream the audio in. Supported formats are sse and audio. sse is not supported for tts-1 or tts-1-hd.

• _input

   final JsonField<String> _input()

  Returns the raw JSON value of input.

  Unlike input, this method doesn't throw if the JSON field has an unexpected type.

• _model

   final JsonField<SpeechModel> _model()

  Returns the raw JSON value of model.

  Unlike model, this method doesn't throw if the JSON field has an unexpected type.

• _voice

   final JsonField<SpeechCreateParams.Voice> _voice()

  Returns the raw JSON value of voice.

  Unlike voice, this method doesn't throw if the JSON field has an unexpected type.

• _instructions

   final JsonField<String> _instructions()

  Returns the raw JSON value of instructions.

  Unlike instructions, this method doesn't throw if the JSON field has an unexpected type.

• _responseFormat

   final JsonField<SpeechCreateParams.ResponseFormat> _responseFormat()

  Returns the raw JSON value of responseFormat.

  Unlike responseFormat, this method doesn't throw if the JSON field has an unexpected type.

• _speed

   final JsonField<Double> _speed()

  Returns the raw JSON value of speed.

  Unlike speed, this method doesn't throw if the JSON field has an unexpected type.

• _streamFormat

   final JsonField<SpeechCreateParams.StreamFormat> _streamFormat()

  Returns the raw JSON value of streamFormat.

  Unlike streamFormat, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final SpeechCreateParams.Body.Builder toBuilder()

• validate

   final SpeechCreateParams.Body validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static SpeechCreateParams.Body.Builder builder()

  Returns a mutable builder for constructing an instance of Body.

  The following fields are required:

  .input()
  .model()
  .voice()