Skip to content

Repository navigation

chore(api): document upcoming model shutdowns #1296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbeckwith-oai merged 1 commit into from
Oct 28, 2026
Merged

chore(api): document upcoming model shutdowns #1296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
schema_version: 1
generation_id: 701cfe20-cca0-4f75-930e-fae767df052d
openapi_spec_hash: d06e3765a1468ab50551d5f592aee3ff
openapi_transformed_spec_hash: 77d448b70f17040eba85818412c76294
generation_id: 32fb0e38-c5c8-41b4-8e4f-f64bc8fd3097
openapi_spec_hash: a17944ab499eb2b5cd24d311d6f430d5
openapi_transformed_spec_hash: e50bfb4700ea58bcc4393a4e3d8f355d
config_hash: 54aec5b489c23fe13627007ad508b52c
codegen_sha: e44fa4dbebb96fe6a00032ad18eb513690db577c
codegen_hash: dcfac53573ac03ec11adb5f2d83323ccda68ac25d87ad72ff7c21490f230deea
codegen_sha: e848b088834c640a4d9716fafda0ee3f50c0839d
codegen_hash: bd3a1adb14b0550b52d2489a1d021715550192c6f319b0c85edf3bef684fe56b
140 changes: 139 additions & 1 deletion api_reference/openapi.transformed.yml
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 22 additions & 2 deletions openai-java-core/src/main/kotlin/com/openai/models/ChatModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St

@JvmField val GPT_5_4_MINI_2026_03_17 = of("gpt-5.4-mini-2026-03-17")

@JvmField val GPT_5_4_NANO_2026_03_17 = of("gpt-5.4-nano-2026-03-17")
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_4_NANO_2026_03_17 = of("gpt-5.4-nano-2026-03-17")

@Deprecated(
"Announced shutdown date: 2026-08-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down Expand Up @@ -80,7 +84,11 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St
@JvmField
val GPT_5_1 = of("gpt-5.1")

@JvmField val GPT_5_1_2025_11_13 = of("gpt-5.1-2025-11-13")
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_1_2025_11_13 = of("gpt-5.1-2025-11-13")

@Deprecated(
"Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down Expand Up @@ -504,6 +512,9 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St
)
GPT_5_4_NANO,
GPT_5_4_MINI_2026_03_17,
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_4_NANO_2026_03_17,
@Deprecated(
"Announced shutdown date: 2026-08-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand All @@ -521,6 +532,9 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_1,
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_1_2025_11_13,
@Deprecated(
"Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down Expand Up @@ -816,6 +830,9 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St
)
GPT_5_4_NANO,
GPT_5_4_MINI_2026_03_17,
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_4_NANO_2026_03_17,
@Deprecated(
"Announced shutdown date: 2026-08-10. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand All @@ -833,6 +850,9 @@ class ChatModel @JsonCreator private constructor(private val value: JsonField<St
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_1,
@Deprecated(
"Announced shutdown date: 2027-04-01. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_1_2025_11_13,
@Deprecated(
"Announced shutdown date: 2026-07-23. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down
66 changes: 58 additions & 8 deletions openai-java-core/src/main/kotlin/com/openai/models/audio/AudioModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,63 @@ class AudioModel @JsonCreator private constructor(private val value: JsonField<S

companion object {

@JvmField val WHISPER_1 = of("whisper-1")
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val WHISPER_1 = of("whisper-1")

@JvmField val GPT_TRANSCRIBE = of("gpt-transcribe")

@JvmField val GPT_4O_TRANSCRIBE = of("gpt-4o-transcribe")

@JvmField val GPT_4O_MINI_TRANSCRIBE = of("gpt-4o-mini-transcribe")

@JvmField val GPT_4O_MINI_TRANSCRIBE_2025_12_15 = of("gpt-4o-mini-transcribe-2025-12-15")

@JvmField val GPT_4O_TRANSCRIBE_DIARIZE = of("gpt-4o-transcribe-diarize")
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_TRANSCRIBE = of("gpt-4o-transcribe")

@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_MINI_TRANSCRIBE = of("gpt-4o-mini-transcribe")

@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_MINI_TRANSCRIBE_2025_12_15 = of("gpt-4o-mini-transcribe-2025-12-15")

@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_TRANSCRIBE_DIARIZE = of("gpt-4o-transcribe-diarize")

@JvmStatic fun of(value: String) = AudioModel(JsonField.of(value))
}

/** An enum containing [AudioModel]'s known values. */
enum class Known {
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
WHISPER_1,
GPT_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TRANSCRIBE_2025_12_15,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_TRANSCRIBE_DIARIZE,
}

Expand All @@ -55,11 +90,26 @@ class AudioModel @JsonCreator private constructor(private val value: JsonField<S
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
WHISPER_1,
GPT_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TRANSCRIBE,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TRANSCRIBE_2025_12_15,
@Deprecated(
"Announced shutdown date: 2027-02-26. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_TRANSCRIBE_DIARIZE,
/** An enum member indicating that [AudioModel] was instantiated with an unknown value. */
_UNKNOWN,
Expand Down
8 changes: 8 additions & 0 deletions openai-java-core/src/main/kotlin/com/openai/models/audio/speech/SpeechCreateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ import kotlin.jvm.optionals.getOrNull
* Generates audio from the input text.
*
* Returns the audio file content, or a stream of audio events.
*
* The `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, `gpt-4o-mini-tts-2025-03-20`, and
* `gpt-4o-mini-tts-2025-12-15` models are deprecated and scheduled to shut down on January 6, 2027.
* These examples use the existing Speech API; for new integrations, migrate to
* `gpt-realtime-2.1-mini` through the
* [Realtime API](https://developers.openai.com/api/docs/guides/realtime). See the
* [deprecation schedule](https://developers.openai.com/api/docs/deprecations) for migration
* details.
*/
class SpeechCreateParams
private constructor(
Expand Down
54 changes: 47 additions & 7 deletions openai-java-core/src/main/kotlin/com/openai/models/audio/speech/SpeechModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,50 @@ class SpeechModel @JsonCreator private constructor(private val value: JsonField<

companion object {

@JvmField val TTS_1 = of("tts-1")

@JvmField val TTS_1_HD = of("tts-1-hd")

@JvmField val GPT_4O_MINI_TTS = of("gpt-4o-mini-tts")

@JvmField val GPT_4O_MINI_TTS_2025_12_15 = of("gpt-4o-mini-tts-2025-12-15")
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val TTS_1 = of("tts-1")

@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val TTS_1_HD = of("tts-1-hd")

@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_MINI_TTS = of("gpt-4o-mini-tts")

@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_4O_MINI_TTS_2025_12_15 = of("gpt-4o-mini-tts-2025-12-15")

@JvmStatic fun of(value: String) = SpeechModel(JsonField.of(value))
}

/** An enum containing [SpeechModel]'s known values. */
enum class Known {
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
TTS_1,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
TTS_1_HD,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TTS,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TTS_2025_12_15,
}

Expand All @@ -49,9 +77,21 @@ class SpeechModel @JsonCreator private constructor(private val value: JsonField<
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
TTS_1,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
TTS_1_HD,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TTS,
@Deprecated(
"Announced shutdown date: 2027-01-06. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_4O_MINI_TTS_2025_12_15,
/** An enum member indicating that [SpeechModel] was instantiated with an unknown value. */
_UNKNOWN,
Expand Down
10 changes: 9 additions & 1 deletion ...java-core/src/main/kotlin/com/openai/models/audio/translations/TranslationCreateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,15 @@ import java.util.Optional
import kotlin.io.path.inputStream
import kotlin.io.path.name

/** Translates audio into English. */
/**
* Translates audio into English.
*
* This endpoint supports only `whisper-1`. The endpoint and model are deprecated and scheduled to
* shut down on February 26, 2027. Migrate to `/v1/realtime/translations`, which requires a separate
* integration. See the [deprecation schedule](https://developers.openai.com/api/docs/deprecations)
* for details.
*/
@Deprecated("deprecated")
class TranslationCreateParams
private constructor(
private val body: Body,
Expand Down
72 changes: 66 additions & 6 deletions openai-java-core/src/main/kotlin/com/openai/models/beta/assistants/AssistantUpdateParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,17 +1745,41 @@ private constructor(

companion object {

@JvmField val GPT_5 = of("gpt-5")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5 = of("gpt-5")

@JvmField val GPT_5_MINI = of("gpt-5-mini")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_MINI = of("gpt-5-mini")

@JvmField val GPT_5_NANO = of("gpt-5-nano")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_NANO = of("gpt-5-nano")

@JvmField val GPT_5_2025_08_07 = of("gpt-5-2025-08-07")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_2025_08_07 = of("gpt-5-2025-08-07")

@JvmField val GPT_5_MINI_2025_08_07 = of("gpt-5-mini-2025-08-07")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_MINI_2025_08_07 = of("gpt-5-mini-2025-08-07")

@JvmField val GPT_5_NANO_2025_08_07 = of("gpt-5-nano-2025-08-07")
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
@JvmField
val GPT_5_NANO_2025_08_07 = of("gpt-5-nano-2025-08-07")

@Deprecated(
"Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down Expand Up @@ -1850,11 +1874,29 @@ private constructor(

/** An enum containing [Model]'s known values. */
enum class Known {
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_MINI,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_NANO,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_2025_08_07,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_MINI_2025_08_07,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_NANO_2025_08_07,
@Deprecated(
"Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down Expand Up @@ -1916,11 +1958,29 @@ private constructor(
* - It was constructed with an arbitrary value using the [of] method.
*/
enum class Value {
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_MINI,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_NANO,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_2025_08_07,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_MINI_2025_08_07,
@Deprecated(
"Announced shutdown date: 2026-12-11. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
)
GPT_5_NANO_2025_08_07,
@Deprecated(
"Announced shutdown date: 2027-01-14. See https://developers.openai.com/api/docs/deprecations for details and recommended replacements."
Expand Down
Loading
Loading