Skip to content

Commit 21de296

Browse files
committed
fix edits api path
1 parent 24af050 commit 21de296

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

articles/ai-services/openai/includes/api-versions/new-inference-preview.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -634,20 +634,21 @@ Status Code: 200
634634
}
635635
```
636636

637-
## Create image edit
637+
## Image generations - Edit
638638

639639
```HTTP
640-
POST {endpoint}/openai/v1/images/edits?api-version=preview
640+
POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview
641641
```
642642

643-
643+
Edits an image from a text caption on a given gpt-image-1 model deployment
644644

645645
### URI Parameters
646646

647647
| Name | In | Required | Type | Description |
648648
|------|------|----------|------|-----------|
649649
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
650-
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
650+
| deployment-id | path | Yes | string | |
651+
| api-version | query | Yes | string | |
651652

652653
### Request Header
653654

@@ -663,34 +664,33 @@ POST {endpoint}/openai/v1/images/edits?api-version=preview
663664

664665
| Name | Type | Description | Required | Default |
665666
|------|------|-------------|----------|---------|
666-
| background | enum | Allows to set transparency for the background of the generated image(s). <br>This parameter is only supported for `gpt-image-1`. Must be one of <br>`transparent`, `opaque` or `auto` (default value). When `auto` is used, the <br>model will automatically determine the best background for the image.<br><br>If `transparent`, the output format needs to support transparency, so it <br>should be set to either `png` (default value) or `webp`.<br>Possible values: `transparent`, `opaque`, `auto` | No | |
667-
| image | string or array | | Yes | |
668-
| mask | string | | No | |
669-
| model | string | The model deployment to use for the image edit operation. | Yes | |
670-
| n | integer | The number of images to generate. Must be between 1 and 10. | No | 1 |
671-
| prompt | string | A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2`, and 32000 characters for `gpt-image-1`. | Yes | |
672-
| quality | enum | The quality of the image that will be generated. `high`, `medium` and `low` are only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality. Defaults to `auto`.<br>Possible values: `standard`, `low`, `medium`, `high`, `auto` | No | |
673-
| response_format | enum | 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`, as `gpt-image-1` will always return base64-encoded images.<br>Possible values: `url`, `b64_json` | No | |
674-
| size | enum | The size of the generated images. Must be one of `1024x1024`, `1536x1024` (landscape), `1024x1536` (portrait), or `auto` (default value) for `gpt-image-1`, and one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`.<br>Possible values: `256x256`, `512x512`, `1024x1024`, `1536x1024`, `1024x1536`, `auto` | No | |
675-
| user | string | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. | No | |
667+
| image | string or array | The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, or jpg file less than 25MB. | Yes | |
668+
| mask | string | An additional image whose fully transparent areas (e.g., where alpha is zero) indicate where the image should be edited. If there are multiple images provided, the mask will be applied to the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as the image. | No | |
669+
| n | integer | The number of images to generate. | No | 1 |
670+
| prompt | string | A text description of the desired image(s). The maximum length is 32000 characters. | Yes | |
671+
| quality | [imageQuality](#imagequality) | The quality of the image that will be generated. | No | auto |
672+
| response_format | [imagesResponseFormat](#imagesresponseformat) | The format in which the generated images are returned. | No | url |
673+
| size | [imageSize](#imagesize) | The size of the generated images. | No | auto |
674+
| user | string | A unique identifier representing your end-user, which can help to monitor and detect abuse. | No | |
676675

677676
### Responses
678677

679678
**Status Code:** 200
680679

681-
**Description**: The request has succeeded.
680+
**Description**: Ok
682681

683682
|**Content-Type**|**Type**|**Description**|
684683
|:---|:---|:---|
685-
|application/json | [AzureImagesResponse](#azureimagesresponse) | |
684+
|application/json | [generateImagesResponse](#generateimagesresponse) | |
686685

687686
**Status Code:** default
688687

689-
**Description**: An unexpected error response.
688+
**Description**: An error occurred.
690689

691690
|**Content-Type**|**Type**|**Description**|
692691
|:---|:---|:---|
693-
|application/json | [AzureErrorResponse](#azureerrorresponse) | |
692+
|application/json | [dalleErrorResponse](#dalleerrorresponse) | |
693+
694694

695695
## Create image
696696

0 commit comments

Comments
 (0)