feat(api): add image sizes, reasoning encryption

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 97
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-8b68ae6b807dca92e914da1dd9e835a20f69b075e79102a264367fd7fddddb33.yml
-openapi_spec_hash: b6ade5b1a6327339e6669e1134de2d03
-config_hash: b597cd9a31e9e5ec709e2eefb4c54122
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-0ee6b36cf3cc278cef4199a6aec5f7d530a6c1f17a74830037e96d50ca1edc50.yml
+openapi_spec_hash: e8ec5f46bc0655b34f292422d58a60f6
+config_hash: d9b6b6e6bc85744663e300eebc482067

src/resources/audio/speech.ts

@@ -66,7 +66,7 @@ export interface SpeechCreateParams {
 
   /**
    * The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
-   * the default.
+   * the default. Does not work with `gpt-4o-mini-tts`.
    */
   speed?: number;
 }

src/resources/images.ts

@@ -162,10 +162,13 @@ export interface ImageCreateVariationParams {
 
 export interface ImageEditParams {
   /**
-   * The image(s) to edit. Must be a supported image file or an array of images. For
-   * `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
-   * 25MB. For `dall-e-2`, you can only provide one image, and it should be a square
-   * `png` file less than 4MB.
+   * The image(s) to edit. Must be a supported image file or an array of images.
+   *
+   * For `gpt-image-1`, each image should be a `png`, `webp`, or `jpg` file less than
+   * 25MB. 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: Core.Uploadable | Array<Core.Uploadable>;
 
@@ -175,6 +178,17 @@ export interface ImageEditParams {
    */
   prompt: string;
 
+  /**
+   * Allows to set transparency for the background of the generated image(s). This
+   * parameter is only supported for `gpt-image-1`. Must be one of `transparent`,
+   * `opaque` or `auto` (default value). When `auto` is used, the model will
+   * automatically determine the best background for the image.
+   *
+   * If `transparent`, the output format needs to support transparency, so it should
+   * be set to either `png` (default value) or `webp`.
+   */
+  background?: 'transparent' | 'opaque' | 'auto' | null;
+
   /**
    * An additional image whose fully transparent areas (e.g. where alpha is zero)
    * indicate where `image` should be edited. If there are multiple images provided,
@@ -215,7 +229,7 @@ export interface ImageEditParams {
    * (landscape), `1024x1536` (portrait), or `auto` (default value) for
    * `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.
    */
-  size?: '256x256' | '512x512' | '1024x1024' | null;
+  size?: '256x256' | '512x512' | '1024x1024' | '1536x1024' | '1024x1536' | 'auto' | null;
 
   /**
    * A unique identifier representing your end-user, which can help OpenAI to monitor

src/resources/responses/responses.ts

@@ -158,7 +158,7 @@ export interface ComputerTool {
   /**
    * The type of computer environment to control.
    */
-  environment: 'mac' | 'windows' | 'ubuntu' | 'browser';
+  environment: 'windows' | 'mac' | 'linux' | 'ubuntu' | 'browser';
 
   /**
    * The type of the computer use tool. Always `computer_use_preview`.
@@ -209,9 +209,9 @@ export interface FileSearchTool {
   vector_store_ids: Array<string>;
 
   /**
-   * A filter to apply based on file attributes.
+   * A filter to apply.
    */
-  filters?: Shared.ComparisonFilter | Shared.CompoundFilter;
+  filters?: Shared.ComparisonFilter | Shared.CompoundFilter | null;
 
   /**
    * The maximum number of results to return. This number should be between 1 and 50
@@ -258,12 +258,12 @@ export interface FunctionTool {
   /**
    * A JSON schema object describing the parameters of the function.
    */
-  parameters: Record<string, unknown>;
+  parameters: Record<string, unknown> | null;
 
   /**
    * Whether to enforce strict parameter validation. Default `true`.
    */
-  strict: boolean;
+  strict: boolean | null;
 
   /**
    * The type of the function tool. Always `function`.
@@ -1581,11 +1581,17 @@ export interface ResponseInProgressEvent {
  * - `message.input_image.image_url`: Include image urls from the input message.
  * - `computer_call_output.output.image_url`: Include image urls from the computer
  *   call output.
+ * - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+ *   tokens in reasoning item outputs. This enables reasoning items to be used in
+ *   multi-turn conversations when using the Responses API statelessly (like when
+ *   the `store` parameter is set to `false`, or when an organization is enrolled
+ *   in the zero data retention program).
  */
 export type ResponseIncludable =
   | 'file_search_call.results'
   | 'message.input_image.image_url'
-  | 'computer_call_output.output.image_url';
+  | 'computer_call_output.output.image_url'
+  | 'reasoning.encrypted_content';
 
 /**
  * An event that is emitted when a response finishes as incomplete.
@@ -1650,7 +1656,7 @@ export interface ResponseInputFile {
   /**
    * The ID of the file to be sent to the model.
    */
-  file_id?: string;
+  file_id?: string | null;
 
   /**
    * The name of the file to be sent to the model.
@@ -1667,7 +1673,7 @@ export interface ResponseInputImage {
    * The detail level of the image to be sent to the model. One of `high`, `low`, or
    * `auto`. Defaults to `auto`.
    */
-  detail: 'high' | 'low' | 'auto';
+  detail: 'low' | 'high' | 'auto';
 
   /**
    * The type of the input item. Always `input_image`.
@@ -1758,19 +1764,19 @@ export namespace ResponseInputItem {
     /**
      * The ID of the computer tool call output.
      */
-    id?: string;
+    id?: string | null;
 
     /**
      * The safety checks reported by the API that have been acknowledged by the
      * developer.
      */
-    acknowledged_safety_checks?: Array<ComputerCallOutput.AcknowledgedSafetyCheck>;
+    acknowledged_safety_checks?: Array<ComputerCallOutput.AcknowledgedSafetyCheck> | null;
 
     /**
      * The status of the message input. One of `in_progress`, `completed`, or
      * `incomplete`. Populated when input items are returned via API.
      */
-    status?: 'in_progress' | 'completed' | 'incomplete';
+    status?: 'in_progress' | 'completed' | 'incomplete' | null;
   }
 
   export namespace ComputerCallOutput {
@@ -1786,12 +1792,12 @@ export namespace ResponseInputItem {
       /**
        * The type of the pending safety check.
        */
-      code: string;
+      code?: string | null;
 
       /**
        * Details about the pending safety check.
        */
-      message: string;
+      message?: string | null;
     }
   }
 
@@ -1818,13 +1824,13 @@ export namespace ResponseInputItem {
      * The unique ID of the function tool call output. Populated when this item is
      * returned via API.
      */
-    id?: string;
+    id?: string | null;
 
     /**
      * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
      * Populated when items are returned via API.
      */
-    status?: 'in_progress' | 'completed' | 'incomplete';
+    status?: 'in_progress' | 'completed' | 'incomplete' | null;
   }
 
   /**
@@ -1839,7 +1845,7 @@ export namespace ResponseInputItem {
     /**
      * The type of item to reference. Always `item_reference`.
      */
-    type: 'item_reference';
+    type?: 'item_reference' | null;
   }
 }
 
@@ -2119,7 +2125,9 @@ export namespace ResponseOutputText {
 
 /**
  * A description of the chain of thought used by a reasoning model while generating
- * a response.
+ * a response. Be sure to include these items in your `input` to the Responses API
+ * for subsequent turns of a conversation if you are manually
+ * [managing context](https://platform.openai.com/docs/guides/conversation-state).
  */
 export interface ResponseReasoningItem {
   /**
@@ -2137,6 +2145,12 @@ export interface ResponseReasoningItem {
    */
   type: 'reasoning';
 
+  /**
+   * The encrypted content of the reasoning item - populated when a response is
+   * generated with `reasoning.encrypted_content` in the `include` parameter.
+   */
+  encrypted_content?: string | null;
+
   /**
    * The status of the item. One of `in_progress`, `completed`, or `incomplete`.
    * Populated when items are returned via API.
@@ -2730,11 +2744,9 @@ export interface ResponseWebSearchCallSearchingEvent {
 }
 
 /**
- * A tool that searches for relevant content from uploaded files. Learn more about
- * the
- * [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
+ * A tool that can be used to generate a response.
  */
-export type Tool = FileSearchTool | FunctionTool | ComputerTool | WebSearchTool;
+export type Tool = FileSearchTool | FunctionTool | WebSearchTool | ComputerTool;
 
 /**
  * Use this option to force the model to call a specific function.
@@ -2788,10 +2800,8 @@ export interface ToolChoiceTypes {
  */
 export interface WebSearchTool {
   /**
-   * The type of the web search tool. One of:
-   *
-   * - `web_search_preview`
-   * - `web_search_preview_2025_03_11`
+   * The type of the web search tool. One of `web_search_preview` or
+   * `web_search_preview_2025_03_11`.
    */
   type: 'web_search_preview' | 'web_search_preview_2025_03_11';
 
@@ -2801,10 +2811,16 @@ export interface WebSearchTool {
    */
   search_context_size?: 'low' | 'medium' | 'high';
 
+  /**
+   * The user's location.
+   */
   user_location?: WebSearchTool.UserLocation | null;
 }
 
 export namespace WebSearchTool {
+  /**
+   * The user's location.
+   */
   export interface UserLocation {
     /**
      * The type of location approximation. Always `approximate`.
@@ -2814,24 +2830,24 @@ export namespace WebSearchTool {
     /**
      * Free text input for the city of the user, e.g. `San Francisco`.
      */
-    city?: string;
+    city?: string | null;
 
     /**
      * The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
      * the user, e.g. `US`.
      */
-    country?: string;
+    country?: string | null;
 
     /**
      * Free text input for the region of the user, e.g. `California`.
      */
-    region?: string;
+    region?: string | null;
 
     /**
      * The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
      * user, e.g. `America/Los_Angeles`.
      */
-    timezone?: string;
+    timezone?: string | null;
   }
 }
 
@@ -2869,6 +2885,11 @@ export interface ResponseCreateParamsBase {
    * - `message.input_image.image_url`: Include image urls from the input message.
    * - `computer_call_output.output.image_url`: Include image urls from the computer
    *   call output.
+   * - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
+   *   tokens in reasoning item outputs. This enables reasoning items to be used in
+   *   multi-turn conversations when using the Responses API statelessly (like when
+   *   the `store` parameter is set to `false`, or when an organization is enrolled
+   *   in the zero data retention program).
    */
   include?: Array<ResponseIncludable> | null;
 

tests/api-resources/images.test.ts

@@ -51,6 +51,7 @@ describe('resource images', () => {
     const response = await client.images.edit({
       image: await toFile(Buffer.from('# my file contents'), 'README.md'),
       prompt: 'A cute baby sea otter wearing a beret',
+      background: 'transparent',
       mask: await toFile(Buffer.from('# my file contents'), 'README.md'),
       model: 'string',
       n: 1,