Create Image Edit

Creates an edited or extended image given one or more source images and a prompt. This endpoint only supports gpt-image-1 and dall-e-2.

Options

Image

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 50MB. 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.

Prompt

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.

Set Mask

Enable to set the optional field Mask

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, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

Set Background

Enable to set the optional field Background

Background

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.

Set Model

Enable to set the optional field Model

Model

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

Set N

Enable to set the optional field N

N

The number of images to generate. Must be between 1 and 10.

Set Size

Enable to set the optional field Size

Size

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.

Set Response Format

Enable to set the optional field Response Format

Response Format

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.

Set Output Format

Enable to set the optional field Output Format

Output Format

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp. The default value is png.

Set Output Compression

Enable to set the optional field Output Compression

Output Compression

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats, and defaults to 100.

Set User

Enable to set the optional field User

User

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

Set Input Fidelity

Enable to set the optional field Input Fidelity

Input Fidelity

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Supports high and low. Defaults to low.

Set Stream

Enable to set the optional field Stream

Stream

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

Set Partial Images

Enable to set the optional field Partial Images

Partial Images

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.

Set Quality

Enable to set the optional field Quality

Quality

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.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Created: The Unix timestamp (in seconds) of when the image was created.
• Data: The list of generated images.
• Background: The background parameter used for the image generation. Either transparent or opaque.
• Output Format: The output format of the image generation. Either png, webp, or jpeg.
• Size: The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
• Quality: The quality of the image generated. Either low, medium, or high.
• Usage: For gpt-image-1 only, the token usage information for the image generation.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers