openai 7.26.0 → 7.28.0

package/src/resources/beta/agents/sessions/sessions.ts

@@ -495,9 +495,8 @@ export namespace SessionCreateParams {
      * - `flex` - Uses the flex service tier.
      * - `priority` - Uses the priority service tier.
      * - `fast` - Uses the fast service tier.
-     * - `ultrafast` - Uses the ultrafast service tier.
      */
-    service_tier?: 'auto' | 'default' | 'flex' | 'priority' | 'fast' | 'ultrafast' | null;
+    service_tier?: 'auto' | 'default' | 'flex' | 'priority' | 'fast' | null;
 
     /**
      * Configuration for text generated by the agent.
@@ -565,9 +564,8 @@ export namespace SessionUpdateParams {
      * - `flex` - Uses the flex service tier.
      * - `priority` - Uses the priority service tier.
      * - `fast` - Uses the fast service tier.
-     * - `ultrafast` - Uses the ultrafast service tier.
      */
-    service_tier?: 'auto' | 'default' | 'flex' | 'priority' | 'fast' | 'ultrafast' | null;
+    service_tier?: 'auto' | 'default' | 'flex' | 'priority' | 'fast' | null;
   }
 
   export namespace Agent {

package/src/resources/beta/responses/responses.ts

@@ -13842,9 +13842,7 @@ export namespace BetaTool {
      * the maximum supported resolution is `3840x2160`. The requested size must also
      * satisfy the model's current pixel and edge limits. The standard sizes
      * `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-     * `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-     * one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-     * `1024x1024`, `1792x1024`, or `1024x1792`.
+     * `auto` is supported for models that allow automatic sizing.
      */
     size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | 'auto';
   }

package/src/resources/chat/completions/completions.ts

@@ -991,7 +991,8 @@ export interface ChatCompletionAudioParam {
    * The voice the model uses to respond. Supported built-in voices are `alloy`,
    * `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
    * `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-   * for example `{ "id": "voice_1234" }`.
+   * for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+   * samples. Voices created from text prompts are supported only in Live.
    */
   voice:
     | string

package/src/resources/images.ts

@@ -20,14 +20,11 @@ function resolveResourceRequestOptions(
  */
 export class Images extends APIResource {
   /**
-   * Creates a variation of a given image. This endpoint only supports `dall-e-2`.
+   * This endpoint is retired and no longer available. Use the image edits endpoint
+   * with a GPT Image model and a prompt to create a variation of an image. The
+   * request and response schemas below describe the legacy contract.
    *
-   * @example
-   * ```ts
-   * const imagesResponse = await client.images.createVariation({
-   *   image: fs.createReadStream('otter.png'),
-   * });
-   * ```
+   * @deprecated
    */
   createVariation(body: ImageCreateVariationParams, options?: RequestOptions): APIPromise<ImagesResponse> {
     return this._client.post(
@@ -40,7 +37,7 @@ export class Images extends APIResource {
 
   /**
    * Creates an edited or extended image given one or more source images and a
-   * prompt. This endpoint supports GPT Image models and `dall-e-2`.
+   * prompt. This endpoint supports GPT Image models.
    *
    * @example
    * ```ts
@@ -78,7 +75,7 @@ export class Images extends APIResource {
   }
 
   /**
-   * Creates an image given a prompt.
+   * Creates an image given a prompt using a GPT Image model.
    * [Learn more](https://developers.openai.com/api/docs/guides/images-vision).
    *
    * @example
@@ -118,21 +115,21 @@ export class Images extends APIResource {
  */
 export interface Image {
   /**
-   * The base64-encoded JSON of the generated image. Returned by default for the GPT
-   * image models, and only present if `response_format` is set to `b64_json` for
-   * `dall-e-2` and `dall-e-3`.
+   * The base64-encoded JSON of the generated image. Returned by default for GPT
+   * image models, or when `response_format` is set to `b64_json` for models that
+   * support that parameter.
    */
   b64_json?: string;
 
   /**
-   * For `dall-e-3` only, the revised prompt that was used to generate the image.
+   * The revised prompt used to generate the image, for models that support prompt
+   * revision. Not returned by GPT image models.
    */
   revised_prompt?: string;
 
   /**
-   * When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-   * `response_format` is set to `url` (default value). Unsupported for the GPT image
-   * models.
+   * The URL of the generated image when `response_format` is set to `url` for models
+   * that support that parameter. Unsupported for GPT image models.
    */
   url?: string;
 }
@@ -419,16 +416,22 @@ export interface ImageGenPartialImageEvent {
  */
 export type ImageGenStreamEvent = ImageGenPartialImageEvent | ImageGenCompletedEvent;
 
+/**
+ * Deprecated values:
+ *
+ * - "dall-e-2", "dall-e-3": This model was retired on May 12, 2026. Use a GPT
+ *   image model instead.
+ */
 export type ImageModel =
-  | 'gpt-image-1'
-  | 'gpt-image-1-mini'
+  | 'gpt-image-1.5'
   | 'gpt-image-2'
   | 'gpt-image-2-2026-04-21'
   | 'gpt-image-2.5-sunburst'
   | 'gpt-image-2.5-sunburst-2026-09-08'
   | 'gpt-image-2.5-flare'
   | 'gpt-image-2.5-flare-2026-09-08'
-  | 'gpt-image-1.5'
+  | 'gpt-image-1'
+  | 'gpt-image-1-mini'
   | 'chatgpt-image-latest'
   | 'dall-e-2'
   | 'dall-e-3';
@@ -547,8 +550,8 @@ export interface ImageCreateVariationParams {
   image: Uploadable;
 
   /**
-   * The model to use for image generation. Only `dall-e-2` is supported at this
-   * time.
+   * The legacy model used by the retired image variations endpoint. This endpoint no
+   * longer accepts requests.
    */
   model?: (string & {}) | ImageModel | null;
 
@@ -590,15 +593,12 @@ export interface ImageEditParamsBase {
    * `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`), each image should
    * be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to 16
    * images.
-   *
-   * For `dall-e-2`, you can only provide one image, and it should be a square `png`
-   * file less than 4MB.
    */
   image: Uploadable | Array<Uploadable>;
 
   /**
-   * A text description of the desired image(s). The maximum length is 1000
-   * characters for `dall-e-2`, and 32000 characters for the GPT image models.
+   * A text description of the desired image(s). The maximum length is 32000
+   * characters for the GPT image models.
    */
   prompt: string;
 
@@ -631,12 +631,11 @@ export interface ImageEditParamsBase {
   mask?: Uploadable;
 
   /**
-   * The model to use for image generation. One of `dall-e-2` or a GPT image model
-   * (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-   * `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
-   * `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-   * `gpt-image-2.5-flare-2026-09-08`, or `chatgpt-image-latest`). Defaults to
-   * `gpt-image-1.5`.
+   * The GPT image model to use for image editing (`gpt-image-1`, `gpt-image-1-mini`,
+   * `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
+   * `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+   * `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
+   * `chatgpt-image-latest`).
    */
   model?: (string & {}) | ImageModel | null;
 
@@ -675,31 +674,28 @@ export interface ImageEditParamsBase {
    * `gpt-image-2.5-flare`, including their `2026-09-08` snapshots, also support
    * `xhigh` and `max`. Defaults to `auto`.
    */
-  quality?: 'standard' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
+  quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | null;
 
   /**
-   * The format in which the generated images are returned. Must be one of `url` or
-   * `b64_json`. URLs are only valid for 60 minutes after the image has been
-   * generated. This parameter is only supported for `dall-e-2` (default is `url` for
-   * `dall-e-2`), as GPT image models always return base64-encoded images.
+   * @deprecated Legacy response format parameter for retired image models.
+   * Unsupported for GPT image models, which always return base64-encoded images.
    */
   response_format?: 'url' | 'b64_json' | null;
 
   /**
-   * The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
-   * `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
-   * `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
-   * resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
-   * Width and height must both be divisible by 16 and the requested aspect ratio
-   * must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
-   * the maximum supported resolution is `3840x2160`. The requested size must also
-   * satisfy the model's current pixel and edge limits. The standard sizes
-   * `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-   * `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-   * one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-   * `1024x1024`, `1792x1024`, or `1024x1792`.
+   * The size of the generated images. Defaults to `auto`. For `gpt-image-2`,
+   * `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+   * `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+   * `gpt-image-2.5-flare-2026-09-08`, arbitrary resolutions are supported as
+   * `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be
+   * divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1.
+   * Resolutions above `2560x1440` are experimental, and the maximum supported
+   * resolution is `3840x2160`. The requested size must also satisfy the model's
+   * current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and
+   * `1024x1536` are supported by the GPT image models; `auto` is supported for
+   * models that allow automatic sizing.
    */
-  size?: (string & {}) | '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
+  size?: (string & {}) | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | '256x256' | '512x512' | null;
 
   /**
    * Edit the image in streaming mode. Defaults to `false`. See the
@@ -744,8 +740,7 @@ export type ImageGenerateParams = ImageGenerateParamsNonStreaming | ImageGenerat
 export interface ImageGenerateParamsBase {
   /**
    * A text description of the desired image(s). The maximum length is 32000
-   * characters for the GPT image models, 1000 characters for `dall-e-2` and 4000
-   * characters for `dall-e-3`.
+   * characters.
    */
   prompt: string;
 
@@ -763,12 +758,11 @@ export interface ImageGenerateParamsBase {
   background?: 'transparent' | 'opaque' | 'auto' | null;
 
   /**
-   * The model to use for image generation. One of `dall-e-2`, `dall-e-3`, or a GPT
-   * image model (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`, `gpt-image-2`,
-   * `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
+   * The GPT image model to use for image generation. Specify a model explicitly.
+   * Supported models include `gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+   * `gpt-image-2`, `gpt-image-2-2026-04-21`, `gpt-image-2.5-sunburst`,
    * `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`,
-   * `gpt-image-2.5-flare-2026-09-08`). Defaults to `dall-e-2` unless a parameter
-   * specific to the GPT image models is used.
+   * `gpt-image-2.5-flare-2026-09-08`, and `chatgpt-image-latest`.
    */
   model?: (string & {}) | ImageModel | null;
 
@@ -780,8 +774,7 @@ export interface ImageGenerateParamsBase {
   moderation?: 'low' | 'auto' | null;
 
   /**
-   * The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only
-   * `n=1` is supported.
+   * The number of images to generate. Must be between 1 and 10.
    */
   n?: number | null;
 
@@ -816,16 +809,12 @@ export interface ImageGenerateParamsBase {
    * - `high`, `medium` and `low` are supported for the GPT image models.
    * - `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their
    *   `2026-09-08` snapshots, also support `xhigh` and `max`.
-   * - `hd` and `standard` are supported for `dall-e-3`.
-   * - `standard` is the only option for `dall-e-2`.
    */
-  quality?: 'standard' | 'hd' | 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
+  quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | 'standard' | 'hd' | null;
 
   /**
-   * The format in which generated images with `dall-e-2` and `dall-e-3` are
-   * returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes
-   * after the image has been generated. This parameter isn't supported for the GPT
-   * image models, which always return base64-encoded images.
+   * @deprecated Legacy response format parameter for retired image models.
+   * Unsupported for GPT image models, which always return base64-encoded images.
    */
   response_format?: 'url' | 'b64_json' | null;
 
@@ -839,9 +828,7 @@ export interface ImageGenerateParamsBase {
    * the maximum supported resolution is `3840x2160`. The requested size must also
    * satisfy the model's current pixel and edge limits. The standard sizes
    * `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-   * `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-   * one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-   * `1024x1024`, `1792x1024`, or `1024x1792`.
+   * `auto` is supported for models that allow automatic sizing.
    */
   size?:
     | (string & {})
@@ -863,10 +850,8 @@ export interface ImageGenerateParamsBase {
   stream?: boolean | null;
 
   /**
-   * The style of the generated images. This parameter is only supported for
-   * `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean
-   * towards generating hyper-real and dramatic images. Natural causes the model to
-   * produce more natural, less hyper-real looking images.
+   * @deprecated Legacy style parameter for retired image models. Unsupported for GPT
+   * image models; describe the desired style in the prompt instead.
    */
   style?: 'vivid' | 'natural' | null;
 

package/src/resources/realtime/realtime.ts

@@ -1302,8 +1302,9 @@ export interface RealtimeAudioConfigOutput {
    * `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
    * `cedar`. You may also provide a custom voice object with an `id`, for example
    * `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
-   * model has responded with audio at least once. We recommend `marin` and `cedar`
-   * for best quality.
+   * model has responded with audio at least once. Custom voices must be created from
+   * audio samples. Voices created from text prompts are supported only in Live. We
+   * recommend `marin` and `cedar` for best quality.
    */
   voice?:
     | string
@@ -2202,8 +2203,9 @@ export namespace RealtimeResponseCreateAudioOutput {
      * `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
      * `cedar`. You may also provide a custom voice object with an `id`, for example
      * `{ "id": "voice_1234" }`. Voice cannot be changed during the session once the
-     * model has responded with audio at least once. We recommend `marin` and `cedar`
-     * for best quality.
+     * model has responded with audio at least once. Custom voices must be created from
+     * audio samples. Voices created from text prompts are supported only in Live. We
+     * recommend `marin` and `cedar` for best quality.
      */
     voice?:
       | string

package/src/resources/responses/responses.ts

@@ -10683,9 +10683,7 @@ export namespace Tool {
      * the maximum supported resolution is `3840x2160`. The requested size must also
      * satisfy the model's current pixel and edge limits. The standard sizes
      * `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
-     * `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
-     * one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
-     * `1024x1024`, `1792x1024`, or `1024x1792`.
+     * `auto` is supported for models that allow automatic sizing.
      */
     size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | 'auto';
   }

package/src/resources/shared.ts

@@ -24,6 +24,70 @@ export type AllModels =
   | 'gpt-5.6-cyber'
   | 'gpt-rosalind-research';
 
+/**
+ * Deprecated values:
+ *
+ * - "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":
+ *   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":
+ *   Announced shutdown date: 2026-12-11. 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": 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.
+ */
 export type ChatModel =
   | 'gpt-6-astra'
   | 'gpt-6.1-sol'

package/src/resources/webhooks/api.md

@@ -2,6 +2,11 @@
 
 Types:
 
+- <code><a href="./src/resources/webhooks/webhooks.ts">AgentSessionActionRequiredWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">AgentSessionCreatedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">AgentSessionFailedWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">AgentSessionIdleWebhookEvent</a></code>
+- <code><a href="./src/resources/webhooks/webhooks.ts">AgentSessionInProgressWebhookEvent</a></code>
 - <code><a href="./src/resources/webhooks/webhooks.ts">BatchCancelledWebhookEvent</a></code>
 - <code><a href="./src/resources/webhooks/webhooks.ts">BatchCompletedWebhookEvent</a></code>
 - <code><a href="./src/resources/webhooks/webhooks.ts">BatchExpiredWebhookEvent</a></code>