@@ -1215,17 +1215,21 @@ Generates a batch of images from a text caption on a given DALL-E or GPT-image-1
1215
1215
1216
1216
** Content-Type** : application/json
1217
1217
1218
+
1218
1219
| Name | Type | Description | Required | Default |
1219
1220
| ------| ------| -------------| ----------| ---------|
1220
1221
| n | integer | The number of images to generate. | No | 1 |
1221
1222
| prompt | string | A text description of the desired image(s). The maximum length is 4000 characters. | Yes | |
1222
1223
| quality | [ imageQuality] ( #imagequality ) | The quality of the image that will be generated. | No | standard (for DALL-E)</br >high (for GPT-image-1) |
1223
1224
| response_format | [ imagesResponseFormat] ( #imagesresponseformat ) | The format in which the generated images are returned. | No | url |
1224
1225
| size | [ imageSize] ( #imagesize ) | The size of the generated images. | No | 1024x1024 |
1225
- | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. | No | vivid |
1226
+ | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. (DALL-E 3 only) | No | vivid |
1226
1227
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
1227
- | output_format | string | The format in which the generated images are returned. GPT-image-1 models only. | No | PNG |
1228
- | output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
1228
+ | output_format | [ imageOutputFormat] ( #imageoutputformat ) | The format in which the generated images are returned. (GPT-image-1 only) | No | PNG |
1229
+ | safety | [ imageSafety] ( #imagesafety ) | The safety setting of the image generation process. (GPT-image-1 only) | No | auto |
1230
+ | No | auto |
1231
+ | background | [ imageBackground] ( #imagebackground ) | The desired appearance of the background of the image. (GPT-image-1 only) | No | auto |
1232
+ | compression_level | integer | The compression level (on a scale of 0-100) of the generated images. (GPT-image-1 only) | No | 0 |
1229
1233
1230
1234
### Responses
1231
1235
@@ -1355,6 +1359,7 @@ Generates an image based on an input image and text prompt instructions. Require
1355
1359
1356
1360
** Content-Type** : application/json
1357
1361
1362
+
1358
1363
| Name | Type | Description | Required | Default |
1359
1364
| ------| ------| -------------| ----------| ---------|
1360
1365
| image | file | The input image to edit. Must be a valid image URL or base64-encoded image. | Yes | |
@@ -1364,10 +1369,8 @@ Generates an image based on an input image and text prompt instructions. Require
1364
1369
| quality | string | The quality of the image that will be generated. Values are 'low', 'medium', 'high' | No | high |
1365
1370
| response_format | [ imagesResponseFormat] ( #imagesresponseformat ) | The format in which the generated images are returned. | No | url |
1366
1371
| size | [ imageSize] ( #imagesize ) | The size of the generated images. | No | 1024x1024 |
1367
- | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. | No | vivid |
1368
1372
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
1369
1373
| output_format | [ imageOutputFormat] ( #imageoutputformat ) | The format in which the generated images are returned. | No | PNG |
1370
- | output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
1371
1374
1372
1375
1373
1376
### Responses
@@ -6121,13 +6124,24 @@ Speech request.
6121
6124
| speed | number | The speed of the synthesized audio. Select a value from ` 0.25 ` to ` 4.0 ` . ` 1.0 ` is the default. | No | 1.0 |
6122
6125
| voice | enum | The voice to use for speech synthesis.<br >Possible values: ` alloy ` , ` echo ` , ` fable ` , ` onyx ` , ` nova ` , ` shimmer ` | Yes | |
6123
6126
6127
+ ### imageBackground
6128
+
6129
+ The desired appearance of the background of the image.
6130
+
6131
+ | Property | Value |
6132
+ | ----------| -------|
6133
+ | ** Description** | The desired appearance of the background of the image. |
6134
+ | ** Type** | string |
6135
+ | ** Default** | auto |
6136
+ | ** Values** | ` transparent ` </br >` opaque ` </br >` auto ` |
6137
+
6124
6138
### imageOutputFormat
6125
6139
6126
- The requested output format for the generated image .
6140
+ The format in which the generated images are returned .
6127
6141
6128
6142
| Property | Value |
6129
6143
| ----------| -------|
6130
- | ** Description** | The requested output format for the generated image . |
6144
+ | ** Description** | The format in which the generated images are returned . |
6131
6145
| ** Type** | string |
6132
6146
| ** Default** | PNG |
6133
6147
| ** Values** | ` PNG ` <br >` JPEG ` |
@@ -6154,6 +6168,19 @@ The format in which the generated images are returned.
6154
6168
| ** Default** | url |
6155
6169
| ** Values** | ` url ` <br >` b64_json ` |
6156
6170
6171
+ ### imageSafety
6172
+
6173
+ The safety setting of the image generation process.
6174
+
6175
+ | Property | Value |
6176
+ | ----------| -------|
6177
+ | ** Description** | The safety setting of the image generation process. |
6178
+ | ** Type** | string |
6179
+ | ** Default** | auto |
6180
+ | ** Values** | ` strict ` </br >` auto ` |
6181
+
6182
+
6183
+
6157
6184
### imageSize
6158
6185
6159
6186
The size of the generated images.
@@ -6163,7 +6190,7 @@ The size of the generated images.
6163
6190
| ** Description** | The size of the generated images. |
6164
6191
| ** Type** | string |
6165
6192
| ** Default** | 1024x1024 |
6166
- | ** Values** | ` 256x256 ` < br > ` 512x512 ` < br > ` 1792x1024 ` < br > ` 1024x1792 ` < br >` 1024x1024 ` |
6193
+ | ** Values** | ` 256x256 ` , ` 512x512 ` , ` 1792x1024 ` , ` 1024x1792 ` , ` 1024x1024 ` (for DALL-E)</ br >` 1024x1024 ` , ` 1024x1536 ` , ` 1536x1024 ` (for GPT-image-1) |
6167
6194
6168
6195
### imageStyle
6169
6196
@@ -6185,10 +6212,13 @@ The style of the generated images.
6185
6212
| quality | [ imageQuality] ( #imagequality ) | The quality of the image that will be generated. | No | standard (for DALL-E)</br >high (for GPT-image-1) |
6186
6213
| response_format | [ imagesResponseFormat] ( #imagesresponseformat ) | The format in which the generated images are returned. | No | url |
6187
6214
| size | [ imageSize] ( #imagesize ) | The size of the generated images. | No | 1024x1024 |
6188
- | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. | No | vivid |
6215
+ | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. (DALL-E 3 only) | No | vivid |
6189
6216
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
6190
- | output_format | string | The format in which the generated images are returned. GPT-image-1 models only. | No | PNG |
6191
- | output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
6217
+ | output_format | [ imageOutputFormat] ( #imageoutputformat ) | The format in which the generated images are returned. (GPT-image-1 only) | No | PNG |
6218
+ | safety | [ imageSafety] ( #imagesafety ) | The safety setting of the image generation process. (GPT-image-1 only) | No | auto |
6219
+ | No | auto |
6220
+ | background | [ imageBackground] ( #imagebackground ) | The desired appearance of the background of the image. (GPT-image-1 only) | No | auto |
6221
+ | compression_level | integer | The compression level (on a scale of 0-100) of the generated images. (GPT-image-1 only) | No | 0 |
6192
6222
6193
6223
### imageEditsRequest
6194
6224
@@ -6202,10 +6232,9 @@ The style of the generated images.
6202
6232
| quality | string | The quality of the image that will be generated. Values are 'low', 'medium', 'high' | No | high |
6203
6233
| response_format | [ imagesResponseFormat] ( #imagesresponseformat ) | The format in which the generated images are returned. | No | url |
6204
6234
| size | [ imageSize] ( #imagesize ) | The size of the generated images. | No | 1024x1024 |
6205
- | style | [ imageStyle] ( #imagestyle ) | The style of the generated images. | No | vivid |
6206
6235
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
6207
6236
| output_format | [ imageOutputFormat] ( #imageoutputformat ) | The format in which the generated images are returned. | No | PNG |
6208
- | output_compression | integer | The compression level (on a scale of 0-100) of the generated images. GPT-image-1 | No | 0 |
6237
+
6209
6238
6210
6239
6211
6240
0 commit comments