Create image edit

POST https://api.fastapi.ai/v1/images/edits

Creates an edited or extended image given an original image and a prompt.

Request body

image file Required
The image to edit. Must be a valid PNG file, less than 4MB, and square.

prompt string Required
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.

mask string Optional
An additional image whose fully transparent areas indicate where image should be edited.
The mask must be a valid PNG file, less than 4MB, and have the same dimensions as image.

model string Optional Defaults to dall-e-2
The model to use for image editing. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

n integer or null Optional Defaults to 1
The number of images to generate. Must be between 1 and 10.

size string or null Optional
The size of the generated images.
For gpt-image-1, supported sizes are 1024x1024, 1536x1024, and 1024x1536.
For dall-e-2, supported sizes are 256x256, 512x512, and 1024x1024.

quality string Optional Defaults to auto
The quality of the image that will be generated.

auto (default value) will automatically select the best quality for the given model.
high, medium and low are supported for the GPT image models.
standard is the only option for dall-e-2.

response_format string or null Optional Defaults to url
The format in which the generated images are returned. Must be one of url or b64_json.
This parameter is only supported for dall-e-2. For GPT image models, the response is always b64_json.
URLs are only valid for 60 minutes after the image has been generated.

background string or null Optional Defaults to auto
Allows to set transparency for the background of the generated image(s). This parameter is only supported for the GPT image models. 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.

output_format string or null Optional Defaults to png
The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp. The default value is png.

output_compression integer or null Optional Defaults to 100
The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.

input_fidelity string Optional Defaults to low
Controls how much effort the model will put into matching the style and features, especially facial features, of input images. It can be used to help preserve character identity across generations. Supported values are low and high.
Only supported for gpt-image-1.
Defaults to low.

partial_images integer Optional Defaults to 0
The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.
Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

stream boolean Optional Defaults to false
Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

user string Optional
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

Returns an image object.

Example

Request

bash

curl https://api.fastapi.ai/v1/images/edits \
  -H "Authorization: Bearer $FAST_API_KEY" \
  -F "model=gpt-image-1" \
  -F "image=@otter.png" \
  -F "mask=@mask.png" \
  -F "prompt=Modify the image to add a beret on the otter." \
  -F "size=1024x1024"

Response

bash

{
  "created": 1713833628,
  "data": [
    {
      "b64_json": "..."
    }
  ],
  "background": "transparent",
  "output_format": "png",
  "size": "1024x1024",
  "quality": "high",
  "usage": {
    "total_tokens": 100,
    "input_tokens": 50,
    "output_tokens": 50
  }
}

Create image edit ​

Request body ​

Returns ​

Example ​