chore(api): document upcoming model shutdowns

.castiron.stats.yml

@@ -1,7 +1,7 @@
 schema_version: 1
-generation_id: dad1853b-d4db-49fa-aeb4-9ad9ed4321c7
-openapi_spec_hash: ef2dda1aa7b22009e708e923f2d16671
-openapi_transformed_spec_hash: b5655374195dfa2a33c4fdc54c458b55
+generation_id: a7e57032-d27d-48a3-8369-86ac183c1c69
+openapi_spec_hash: 0fa065837f86231ded0decb63dbdf0b7
+openapi_transformed_spec_hash: 56311e2848d7e223897e87450386621c
 config_hash: c504b91d0d2bff67085cca331d9ad209
-codegen_sha: b61522c3eb65200277a41e24aa0abf9eb52a3e1f
-codegen_hash: 8d94c12939cb80cce1a506a86f5de72126b9f676a7b31872ba4bc687b585e6c0
+codegen_sha: b8eda29979a71e324dae3e5888b5e9277b86bc50
+codegen_hash: ef0001ba574b6ca8564d676bfeb592de087e42a10a1e53e243dd0e3a5900950b

scripts/castiron/generated-files.json

@@ -223,23 +223,23 @@
     },
     "src/resources/audio/audio.ts": {
       "mode": "100644",
-      "sha256": "9498f6e960c66d723d01355c8a27b49bf63f1a39a363411c1459bf266f60d501"
+      "sha256": "8453261bfa31ff0461a15e3ca5c04199900dc02af4b8918886a6ac2e505a8d7c"
     },
     "src/resources/audio/index.ts": {
       "mode": "100644",
       "sha256": "72b9c681ba668c18e96cc9f00fda5a094e4c99a84854550b1b7a546463a0d5d3"
     },
     "src/resources/audio/speech.ts": {
       "mode": "100644",
-      "sha256": "8d058285fdb07c8be55bc5c7fc07fe2a7c863ad0646deca292c7c814dae7576e"
+      "sha256": "d0989bdab475785c6000f969d94469673121d82e09fc02778bd81e742712aaad"
     },
     "src/resources/audio/transcriptions.ts": {
       "mode": "100644",
       "sha256": "8a81d4cb4c975cf027f78b8d86feb2fb39e7860b265433a91ebf13bef9f61d80"
     },
     "src/resources/audio/translations.ts": {
       "mode": "100644",
-      "sha256": "7bf24e88987cbe340cc36eab6dd3bea51e0a9c3f7e81dfc807b184ecf520ad18"
+      "sha256": "1868adba37b8cc402975ad3a51f23ae506520abf4bdfb5314b9ed7656bbc404d"
     },
     "src/resources/audio/voice-consents.ts": {
       "mode": "100644",
@@ -451,7 +451,7 @@
     },
     "src/resources/beta/responses/responses.ts": {
       "mode": "100644",
-      "sha256": "f760d2f29d48d247b4c5c7d4afb801cb030ec82420b64fc4be28d7b4b104ea7d"
+      "sha256": "19e24eef832131a1a2802215fbfb9e0f7502034ebb6905a2296358edd9c0d221"
     },
     "src/resources/beta/responses/ws-base.ts": {
       "mode": "100644",
@@ -807,15 +807,15 @@
     },
     "src/resources/realtime/client-secrets.ts": {
       "mode": "100644",
-      "sha256": "f12c8c835fddbc9a251829477537c740efb23d5612ac986d479e78f9eb9e7276"
+      "sha256": "03c530f31e0766e1daddb814d4f88ccc162b177320759dbfa4bf0e0ee08ecda5"
     },
     "src/resources/realtime/index.ts": {
       "mode": "100644",
       "sha256": "52cfa69f89ec858cd6770fcb350a72a3b56dc10460332e850dd5dfa0f6fa2d64"
     },
     "src/resources/realtime/realtime.ts": {
       "mode": "100644",
-      "sha256": "9f296305e3a9f1fb07c015e055f159133537468c47ce7170cc3f7f90f9ca9978"
+      "sha256": "d85ac0e9bbbb22943d10fd442a70859765a86ced94a6470c12be3daf9b89d37f"
     },
     "src/resources/realtime/translations.ts": {
       "mode": "100644",
@@ -863,7 +863,7 @@
     },
     "src/resources/responses/responses.ts": {
       "mode": "100644",
-      "sha256": "9539693b7552bbb0bc2e9a12705ca14728c962f3d2ecb5c01a320d29219ed551"
+      "sha256": "be587df72325b151f6107d3ac3231da47ed50965d59ff6679189c3d5f1a8b280"
     },
     "src/resources/responses/ws-base.ts": {
       "mode": "100644",
@@ -895,7 +895,7 @@
     },
     "src/resources/shared.ts": {
       "mode": "100644",
-      "sha256": "69cef390c30bc7df0dc8b120e37d8ae1e4559e9f68a6d78b36a6a3a0c56063f4"
+      "sha256": "15cf6803634242502525c52098acddea16b9c2bb2439f85aa388dd43fa837455"
     },
     "src/resources/skills.ts": {
       "mode": "100644",

src/resources/audio/audio.ts

@@ -52,6 +52,15 @@ export class Audio extends APIResource {
   voiceConsents: VoiceConsentsAPI.VoiceConsents = new VoiceConsentsAPI.VoiceConsents(this._client);
 }
 
+/**
+ * Deprecated values:
+ *
+ * - "whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe",
+ *   "gpt-4o-mini-transcribe-2025-12-15", "gpt-4o-transcribe-diarize": Announced
+ *   shutdown date: 2027-02-26. See
+ *   https://developers.openai.com/api/docs/deprecations for details and
+ *   recommended replacements.
+ */
 export type AudioModel =
   | 'whisper-1'
   | 'gpt-transcribe'

src/resources/audio/speech.ts

@@ -21,6 +21,14 @@ export class Speech extends APIResource {
    *
    * 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.
+   *
    * @example
    * ```ts
    * const speech = await client.audio.speech.create({
@@ -47,6 +55,14 @@ export class Speech extends APIResource {
   }
 }
 
+/**
+ * Deprecated values:
+ *
+ * - "tts-1", "tts-1-hd", "gpt-4o-mini-tts", "gpt-4o-mini-tts-2025-12-15":
+ *   Announced shutdown date: 2027-01-06. See
+ *   https://developers.openai.com/api/docs/deprecations for details and
+ *   recommended replacements.
+ */
 export type SpeechModel = 'tts-1' | 'tts-1-hd' | 'gpt-4o-mini-tts' | 'gpt-4o-mini-tts-2025-12-15';
 
 export interface SpeechCreateParams {

src/resources/audio/translations.ts

@@ -22,13 +22,13 @@ export class Translations extends APIResource {
   /**
    * Translates audio into English.
    *
-   * @example
-   * ```ts
-   * const translation = await client.audio.translations.create({
-   *   file: fs.createReadStream('speech.mp3'),
-   *   model: 'whisper-1',
-   * });
-   * ```
+   * 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
    */
   create(
     body: TranslationCreateParams<'json' | undefined>,

src/resources/beta/responses/responses.ts

@@ -1430,6 +1430,83 @@ export interface BetaResponse {
    * price points. Refer to the
    * [model guide](https://developers.openai.com/api/docs/models) to browse and
    * compare available models.
+   *
+   * Deprecated values:
+   *
+   * - "gpt-5.4-nano", "gpt-5.4-nano-2026-03-17", "gpt-5.1", "gpt-5.1-2025-11-13":
+   *   Announced shutdown date: 2027-04-01. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-5.3-chat-latest", "gpt-5.2-chat-latest": Announced shutdown date:
+   *   2026-08-10. See https://developers.openai.com/api/docs/deprecations for
+   *   details and recommended replacements.
+   * - "gpt-5.1-codex", "gpt-5.1-chat-latest", "gpt-5-chat-latest",
+   *   "gpt-4o-search-preview", "gpt-4o-mini-search-preview",
+   *   "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11",
+   *   "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research",
+   *   "o4-mini-deep-research-2025-06-26", "computer-use-preview",
+   *   "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5.1-codex-max":
+   *   Announced shutdown date: 2026-07-23. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-5.1-mini": Not a supported model ID. Retained for SDK compatibility.
+   * - "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07",
+   *   "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "o3", "o3-2025-04-16",
+   *   "o3-pro", "o3-pro-2025-06-10", "gpt-5-pro", "gpt-5-pro-2025-10-06": Announced
+   *   shutdown date: 2026-12-11. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14",
+   *   "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-mini",
+   *   "gpt-4o-mini-2024-07-18": Announced shutdown date: 2027-01-14. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-4.1-nano", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16",
+   *   "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "gpt-4o-2024-05-13",
+   *   "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-1106-preview", "gpt-4",
+   *   "gpt-4-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-0125", "o1-pro",
+   *   "o1-pro-2025-03-19": Announced shutdown date: 2026-10-23. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "o1-preview", "o1-preview-2024-09-12": Announced shutdown date: 2025-07-28.
+   *   See https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "o1-mini", "o1-mini-2024-09-12": Announced shutdown date: 2025-10-27. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-audio-mini", "gpt-audio-mini-2025-12-15": Announced shutdown date:
+   *   2027-01-20. See https://developers.openai.com/api/docs/deprecations for
+   *   details and recommended replacements.
+   * - "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-12-17",
+   *   "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview",
+   *   "gpt-4o-mini-audio-preview-2024-12-17": Announced shutdown date: 2026-05-07.
+   *   See https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-4o-audio-preview-2024-10-01": Announced shutdown date: 2025-10-10. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "chatgpt-4o-latest": Announced shutdown date: 2026-02-17. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "codex-mini-latest": Announced shutdown date: 2026-02-12. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-0314": Announced shutdown
+   *   date: 2026-03-26. See https://developers.openai.com/api/docs/deprecations for
+   *   details and recommended replacements.
+   * - "gpt-4-vision-preview": Announced shutdown date: 2024-12-06. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613": Announced shutdown date:
+   *   2025-06-06. See https://developers.openai.com/api/docs/deprecations for
+   *   details and recommended replacements.
+   * - "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613",
+   *   "gpt-3.5-turbo-16k-0613": Announced shutdown date: 2024-09-13. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
+   * - "gpt-3.5-turbo-1106": Announced shutdown date: 2026-09-28. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
    */
   model:
     | 'gpt-6-astra'
@@ -12220,6 +12297,11 @@ export namespace BetaResponseToolSearchOutputItemParam {
      *
      * `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
      * `gpt-image-2.5-flare` instead.
+     *
+     * Deprecated values:
+     *
+     * - "gpt-image-1": GPT Image 1 was shut down on October 23, 2026. Use
+     *   gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
      */
     model?:
       | (string & {})
@@ -12628,6 +12710,83 @@ export namespace BetaResponsesClientEvent {
      * price points. Refer to the
      * [model guide](https://developers.openai.com/api/docs/models) to browse and
      * compare available models.
+     *
+     * Deprecated values:
+     *
+     * - "gpt-5.4-nano", "gpt-5.4-nano-2026-03-17", "gpt-5.1", "gpt-5.1-2025-11-13":
+     *   Announced shutdown date: 2027-04-01. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-5.3-chat-latest", "gpt-5.2-chat-latest": Announced shutdown date:
+     *   2026-08-10. See https://developers.openai.com/api/docs/deprecations for
+     *   details and recommended replacements.
+     * - "gpt-5.1-codex", "gpt-5.1-chat-latest", "gpt-5-chat-latest",
+     *   "gpt-4o-search-preview", "gpt-4o-mini-search-preview",
+     *   "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11",
+     *   "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research",
+     *   "o4-mini-deep-research-2025-06-26", "computer-use-preview",
+     *   "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5.1-codex-max":
+     *   Announced shutdown date: 2026-07-23. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-5.1-mini": Not a supported model ID. Retained for SDK compatibility.
+     * - "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07",
+     *   "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "o3", "o3-2025-04-16",
+     *   "o3-pro", "o3-pro-2025-06-10", "gpt-5-pro", "gpt-5-pro-2025-10-06": Announced
+     *   shutdown date: 2026-12-11. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14",
+     *   "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-mini",
+     *   "gpt-4o-mini-2024-07-18": Announced shutdown date: 2027-01-14. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-4.1-nano", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16",
+     *   "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "gpt-4o-2024-05-13",
+     *   "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-1106-preview", "gpt-4",
+     *   "gpt-4-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-0125", "o1-pro",
+     *   "o1-pro-2025-03-19": Announced shutdown date: 2026-10-23. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "o1-preview", "o1-preview-2024-09-12": Announced shutdown date: 2025-07-28.
+     *   See https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "o1-mini", "o1-mini-2024-09-12": Announced shutdown date: 2025-10-27. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-audio-mini", "gpt-audio-mini-2025-12-15": Announced shutdown date:
+     *   2027-01-20. See https://developers.openai.com/api/docs/deprecations for
+     *   details and recommended replacements.
+     * - "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-12-17",
+     *   "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview",
+     *   "gpt-4o-mini-audio-preview-2024-12-17": Announced shutdown date: 2026-05-07.
+     *   See https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-4o-audio-preview-2024-10-01": Announced shutdown date: 2025-10-10. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "chatgpt-4o-latest": Announced shutdown date: 2026-02-17. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "codex-mini-latest": Announced shutdown date: 2026-02-12. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-0314": Announced shutdown
+     *   date: 2026-03-26. See https://developers.openai.com/api/docs/deprecations for
+     *   details and recommended replacements.
+     * - "gpt-4-vision-preview": Announced shutdown date: 2024-12-06. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613": Announced shutdown date:
+     *   2025-06-06. See https://developers.openai.com/api/docs/deprecations for
+     *   details and recommended replacements.
+     * - "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613",
+     *   "gpt-3.5-turbo-16k-0613": Announced shutdown date: 2024-09-13. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
+     * - "gpt-3.5-turbo-1106": Announced shutdown date: 2026-09-28. See
+     *   https://developers.openai.com/api/docs/deprecations for details and
+     *   recommended replacements.
      */
     model?:
       | 'gpt-6-astra'
@@ -14414,6 +14573,11 @@ export namespace BetaTool {
      *
      * `gpt-image-1` was shut down on October 23, 2026. Use `gpt-image-2.5-sunburst` or
      * `gpt-image-2.5-flare` instead.
+     *
+     * Deprecated values:
+     *
+     * - "gpt-image-1": GPT Image 1 was shut down on October 23, 2026. Use
+     *   gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.
      */
     model?:
       | (string & {})

src/resources/realtime/client-secrets.ts

@@ -111,6 +111,14 @@ export interface RealtimeSessionCreateResponse {
 
   /**
    * The Realtime model used for this session.
+   *
+   * Deprecated values:
+   *
+   * - "gpt-realtime", "gpt-realtime-2025-08-28", "gpt-realtime-mini",
+   *   "gpt-realtime-mini-2025-12-15", "gpt-audio-mini", "gpt-audio-mini-2025-12-15":
+   *   Announced shutdown date: 2027-01-20. See
+   *   https://developers.openai.com/api/docs/deprecations for details and
+   *   recommended replacements.
    */
   model?:
     | (string & {})