chore(api): update image-model documentation

.castiron.stats.yml

@@ -1,7 +1,7 @@
 schema_version: 1
-generation_id: 66c33b8f-b104-40d5-882f-9e511b4c0f84
-openapi_spec_hash: 2c78c708cab402e8904f555026c78020
-openapi_transformed_spec_hash: 078e0a8b0fbf06b663d2a310567695ce
-config_hash: e901e1843aa6ac7c3816ad65338289ac
-codegen_sha: 3f98cde2ae19fc412a1425b432a34c789a42f3cc
-codegen_hash: 1408cfa777ed0a695f6a9a7585f15457a30078e5a4518b18e7589f59e81153a2
+generation_id: 118ddabe-fe6b-4298-945e-8c6620ca6518
+openapi_spec_hash: ef2dda1aa7b22009e708e923f2d16671
+openapi_transformed_spec_hash: 9c2476b34fc1bd1f07ca1c9353122b55
+config_hash: 0e042fd083471fc089bcbfe7011a7d01
+codegen_sha: 9296df390e1dc6119238e97fd60cd3b5cf6a86ac
+codegen_hash: 97a6b18a5145df17893b2cb178d490c1fa4f075cd46b022e8439b29a6df3c979

api_reference/openapi.transformed.yml

@@ -44052,12 +44052,12 @@ components:
           description: |
             The image(s) to edit. Must be a supported image file or an array of images.
 
-            For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`, `gpt-image-1.5`,
+            For the GPT image models (`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`, and `chatgpt-image-latest`), each image
-            should be a `png`, `webp`, or `jpg` file less than 50MB. You can provide up to
-            16 images.
+            `gpt-image-2.5-sunburst-2026-09-08`, `gpt-image-2.5-flare`, and
+            `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or `jpg`
+            file less than 50MB. You can provide up to 16 images. `chatgpt-image-latest`
+            follows the same input constraints as GPT image models.
           x-oaiMeta:
             exampleFilePath: otter.png
         prompt:
@@ -76160,7 +76160,7 @@ components:
       enum:
       - high
       - low
-      description: Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports `high` and `low` on `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+      description: Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports `high` and `low` on `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
     LocalShellToolParam:
       properties:
         type:
@@ -98940,7 +98940,7 @@ components:
       enum:
       - high
       - low
-      description: Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports `high` and `low` on `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+      description: Control how much effort the model will exert to match the style and features, especially facial features, of input images. Supports `high` and `low` on `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
     BetaProgrammaticToolCallingParam:
       properties:
         type:

scripts/castiron/generated-files.json

@@ -543,7 +543,7 @@
     },
     "src/openai/resources/images.py": {
       "mode": "100644",
-      "sha256": "d823e781dc30e74f363760c90a245ba75ae28293514495087239774ecace40c3"
+      "sha256": "51249a721473cb85820b9818ab9bc86db6a67dafec38c37d5fff937914738acf"
     },
     "src/openai/resources/live/__init__.py": {
       "mode": "100644",
@@ -3043,11 +3043,11 @@
     },
     "src/openai/types/beta/beta_response_tool_search_output_item_param.py": {
       "mode": "100644",
-      "sha256": "626950ea43730bce9543c96bebce1718fd3ccdf303c77f31a4672673fa13121a"
+      "sha256": "42877c73a1ea330066a250a6956d4ffd0aa852552ccb443b5c3027fd6857aa13"
     },
     "src/openai/types/beta/beta_response_tool_search_output_item_param_param.py": {
       "mode": "100644",
-      "sha256": "7920227dd83b05caaed0b1722cdb602c1c446ba9089d8ca8628f2afacb1b6b3a"
+      "sha256": "a112f6bc0d8ad99ffd4446574867e7b80562b274e9b3eb9fce37ba93df3114d7"
     },
     "src/openai/types/beta/beta_response_usage.py": {
       "mode": "100644",
@@ -3091,7 +3091,7 @@
     },
     "src/openai/types/beta/beta_tool.py": {
       "mode": "100644",
-      "sha256": "b2113bfb482d18476f20a1634735a99a7cdbeecd621737920445041ce1d8d0d4"
+      "sha256": "72db599a0dbee47b7db58d1d3644af3a831e0745b88eb2690a1ad08b727e1977"
     },
     "src/openai/types/beta/beta_tool_choice_allowed.py": {
       "mode": "100644",
@@ -3155,7 +3155,7 @@
     },
     "src/openai/types/beta/beta_tool_param.py": {
       "mode": "100644",
-      "sha256": "516583a14fda3b95fea765a4defb65a40ba9ba2499844dab226c49c552bf9ca7"
+      "sha256": "68150a4b840dbcdbe5c4efe018d446930dff904a57c07caf0f04f1d398caf2ec"
     },
     "src/openai/types/beta/beta_tool_search_output_namespace_tool.py": {
       "mode": "100644",
@@ -4523,7 +4523,7 @@
     },
     "src/openai/types/image_edit_params.py": {
       "mode": "100644",
-      "sha256": "e6c495ae0269889e18ad6d44bec3855a640ef9d8f916a94cfe4b0967a7b8a739"
+      "sha256": "1468e16c7f7bd5bb5827fdfeb7ca5e3906392993dba59abc0d7b5d60751456f0"
     },
     "src/openai/types/image_edit_partial_image_event.py": {
       "mode": "100644",
@@ -6691,11 +6691,11 @@
     },
     "src/openai/types/responses/response_tool_search_output_item_param.py": {
       "mode": "100644",
-      "sha256": "d25d614693ca86602106515b1e12f26f55f82282c8ef085a5712ec6d18c4f4cb"
+      "sha256": "1b65a676c27102006b69afa0c2d4419280cc018856fdfd7e204419654238dc03"
     },
     "src/openai/types/responses/response_tool_search_output_item_param_param.py": {
       "mode": "100644",
-      "sha256": "a1b20bcb2ccb1e074d2a68a4630c424df7a782063f098ab82cb673e3c877f976"
+      "sha256": "ee6784cfe2dd285c8ee880e25d50396088d3f1f72c7511ea61d9e92ca1d5cbf7"
     },
     "src/openai/types/responses/response_usage.py": {
       "mode": "100644",
@@ -6739,7 +6739,7 @@
     },
     "src/openai/types/responses/tool.py": {
       "mode": "100644",
-      "sha256": "ace9a6241d641f12f1a2461713f542b68109cf2a74f050e2dc0211cc2c5de8b8"
+      "sha256": "07beb87f933d61c9288cbdf08cdc3d2c9d5e6ebd34c8da1a46ba1186f7ba6b29"
     },
     "src/openai/types/responses/tool_choice_allowed.py": {
       "mode": "100644",
@@ -6803,7 +6803,7 @@
     },
     "src/openai/types/responses/tool_param.py": {
       "mode": "100644",
-      "sha256": "abfa0b97b8b47844cc51c6400c0eab3086c2eba8aa1673e0f78abcd889a24b27"
+      "sha256": "96beeed6e6fbe90f379fc05bf1a090cf9fcc02aaca50194b37d70b490713085f"
     },
     "src/openai/types/responses/tool_search_output_namespace_tool.py": {
       "mode": "100644",

src/openai/resources/images.py

@@ -165,12 +165,12 @@ def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -187,8 +187,8 @@ def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,
@@ -303,12 +303,12 @@ def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -329,8 +329,8 @@ def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,
@@ -441,12 +441,12 @@ def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -467,8 +467,8 @@ def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,
@@ -1210,12 +1210,12 @@ async def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -1232,8 +1232,8 @@ async def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,
@@ -1348,12 +1348,12 @@ async def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -1374,8 +1374,8 @@ async def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,
@@ -1486,12 +1486,12 @@ async def edit(
         Args:
           image: The image(s) to edit. Must be a supported image file or an array of images.
 
-              For the GPT image models (`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`, 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 the GPT image models (`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`, and
+              `gpt-image-2.5-flare-2026-09-08`), each image should be a `png`, `webp`, or
+              `jpg` file less than 50MB. You can provide up to 16 images.
+              `chatgpt-image-latest` follows the same input constraints as GPT image models.
 
           prompt: A text description of the desired image(s). The maximum length is 32000
               characters for the GPT image models.
@@ -1512,8 +1512,8 @@ async def edit(
 
           input_fidelity: Control how much effort the model will exert to match the style and features,
               especially facial features, of input images. Supports `high` and `low` on
-              `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-              `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+              `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+              this parameter. Defaults to `low` on supported models.
 
           mask: 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,

src/openai/types/beta/beta_response_tool_search_output_item_param.py

@@ -284,8 +284,8 @@ class ToolImageGeneration(BaseModel):
     """
     Control how much effort the model will exert to match the style and features,
     especially facial features, of input images. Supports `high` and `low` on
-    `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-    `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+    `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+    this parameter. Defaults to `low` on supported models.
     """
 
     input_image_mask: Optional[ToolImageGenerationInputImageMask] = None

src/openai/types/beta/beta_response_tool_search_output_item_param_param.py

@@ -283,8 +283,8 @@ class ToolImageGeneration(TypedDict, total=False):
     """
     Control how much effort the model will exert to match the style and features,
     especially facial features, of input images. Supports `high` and `low` on
-    `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-    `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+    `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+    this parameter. Defaults to `low` on supported models.
     """
 
     input_image_mask: ToolImageGenerationInputImageMask