Speech

Create speech

HttpResponse audio().speech().create(SpeechCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /audio/speech

Generates audio from the input text.

Returns the audio file content, or a stream of audio events.

Parameters

SpeechCreateParams params
- String input
  
  The text to generate audio for. The maximum length is 4096 characters.
- 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.
  - TTS_1("tts-1")
  - TTS_1_HD("tts-1-hd")
  - GPT_4O_MINI_TTS("gpt-4o-mini-tts")
  - GPT_4O_MINI_TTS_2025_12_15("gpt-4o-mini-tts-2025-12-15")
- 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.
  - String
  - enum UnionMember1:
    - ALLOY("alloy")
    - ASH("ash")
    - BALLAD("ballad")
    - CORAL("coral")
    - ECHO("echo")
    - SAGE("sage")
    - SHIMMER("shimmer")
    - VERSE("verse")
    - MARIN("marin")
    - CEDAR("cedar")
  - class Id:
    
    Custom voice reference.
    - String id
      
      The custom voice ID, e.g. voice_1234.
- Optional<String> instructions
  
  Control the voice of your generated audio with additional instructions. Does not work with tts-1 or tts-1-hd.
- Optional<ResponseFormat> responseFormat
  
  The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm.
  - MP3("mp3")
  - OPUS("opus")
  - AAC("aac")
  - FLAC("flac")
  - WAV("wav")
  - PCM("pcm")
- Optional<Double> speed
  
  The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.
- Optional<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.
  - SSE("sse")
  - AUDIO("audio")

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.http.HttpResponse;
import com.openai.models.audio.speech.SpeechCreateParams;
import com.openai.models.audio.speech.SpeechModel;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        SpeechCreateParams params = SpeechCreateParams.builder()
            .input("input")
            .model(SpeechModel.TTS_1)
            .voice("string")
            .build();
        HttpResponse speech = client.audio().speech().create(params);
    }
}

Domain Types

Speech Model

enum SpeechModel:
- TTS_1("tts-1")
- TTS_1_HD("tts-1-hd")
- GPT_4O_MINI_TTS("gpt-4o-mini-tts")
- GPT_4O_MINI_TTS_2025_12_15("gpt-4o-mini-tts-2025-12-15")

java/resources/audio/subresources/speech/index.md +140 −0 created

1# Speech

3## Create speech

5`HttpResponse audio().speech().create(SpeechCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

7**post** `/audio/speech`

9Generates audio from the input text.

11Returns the audio file content, or a stream of audio events.

13### Parameters

15- `SpeechCreateParams params`

17 - `String input`

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

21 - `SpeechModel model`

23 One of the available [TTS models](https://platform.openai.com/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.

25 - `TTS_1("tts-1")`

27 - `TTS_1_HD("tts-1-hd")`

29 - `GPT_4O_MINI_TTS("gpt-4o-mini-tts")`

31 - `GPT_4O_MINI_TTS_2025_12_15("gpt-4o-mini-tts-2025-12-15")`

33 - `Voice voice`

35 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](https://platform.openai.com/docs/guides/text-to-speech#voice-options).

37 - `String`

39 - `enum UnionMember1:`

41 - `ALLOY("alloy")`

43 - `ASH("ash")`

45 - `BALLAD("ballad")`

47 - `CORAL("coral")`

49 - `ECHO("echo")`

51 - `SAGE("sage")`

53 - `SHIMMER("shimmer")`

55 - `VERSE("verse")`

57 - `MARIN("marin")`

59 - `CEDAR("cedar")`

61 - `class Id:`

63 Custom voice reference.

65 - `String id`

67 The custom voice ID, e.g. `voice_1234`.

69 - `Optional<String> instructions`

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

73 - `Optional<ResponseFormat> responseFormat`

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

77 - `MP3("mp3")`

79 - `OPUS("opus")`

81 - `AAC("aac")`

83 - `FLAC("flac")`

85 - `WAV("wav")`

87 - `PCM("pcm")`

89 - `Optional<Double> speed`

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

93 - `Optional<StreamFormat> streamFormat`

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

97 - `SSE("sse")`

99 - `AUDIO("audio")`

100

101### Example

102

103```java

104package com.openai.example;

105

106import com.openai.client.OpenAIClient;

107import com.openai.client.okhttp.OpenAIOkHttpClient;

108import com.openai.core.http.HttpResponse;

109import com.openai.models.audio.speech.SpeechCreateParams;

110import com.openai.models.audio.speech.SpeechModel;

111

112public final class Main {

113 private Main() {}

114

115 public static void main(String[] args) {

116 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

117

118 SpeechCreateParams params = SpeechCreateParams.builder()

119 .input("input")

120 .model(SpeechModel.TTS_1)

121 .voice("string")

122 .build();

123 HttpResponse speech = client.audio().speech().create(params);

124 }

125}

126```

127

128## Domain Types

129

130### Speech Model

131

132- `enum SpeechModel:`

133

134 - `TTS_1("tts-1")`

135

136 - `TTS_1_HD("tts-1-hd")`

137

138 - `GPT_4O_MINI_TTS("gpt-4o-mini-tts")`

139

140 - `GPT_4O_MINI_TTS_2025_12_15("gpt-4o-mini-tts-2025-12-15")`