Skip to main content

Overview

This node generates images using OpenAI’s GPT Image API. It supports multiple models, allows you to provide input images for editing, and can use a mask to specify which parts of an image to modify.

Inputs

ParameterDescriptionData TypeRequiredRange
promptText prompt for GPT Image (default: "").STRINGYesN/A
modelThe OpenAI GPT Image model to use. Selecting a model reveals additional parameters specific to that model.COMBOYes"gpt-image-2"
"gpt-image-1.5"
"gpt-image-1"
model.sizeImage size. Select ‘Custom’ to use the custom width and height (default: “auto”). Only available for gpt-image-2.COMBOYes"auto"
"1024x1024"
"1024x1536"
"1536x1024"
"2048x2048"
"2048x1152"
"1152x2048"
"3840x2160"
"2160x3840"
"Custom"
model.custom_widthUsed only when size is ‘Custom’. Must be a multiple of 16 (default: 1024). Only available for gpt-image-2.INTNo1024 to 3840
model.custom_heightUsed only when size is ‘Custom’. Must be a multiple of 16 (default: 1024). Only available for gpt-image-2.INTNo1024 to 3840
model.backgroundReturn image with or without background (default: “auto”). Only available for gpt-image-2.COMBOYes"auto"
"opaque"
model.qualityThe quality of the generated image. Only available for gpt-image-2.COMBOYes"standard"
"hd"
model.imagesInput images for editing. Only available for gpt-image-2.IMAGENoN/A
model.maskA mask to specify which parts of the input image to edit. Only available for gpt-image-2.MASKNoN/A
nHow many images to generate (default: 1).INTYes1 to 8
seedSeed for reproducibility (default: 0). Note: not implemented yet in backend.INTYes0 to 2147483647
Parameter Constraints and Limitations:
  • When using gpt-image-2 with a model.size of “Custom”, the custom_width and custom_height must be multiples of 16, the maximum edge must be <= 3840, the aspect ratio must not exceed 3:1, and the total pixel count must be between 655,360 and 8,294,400.
  • If a mask is provided, an input image (model.images) is required. A mask cannot be used without an input image.
  • A mask cannot be used with multiple input images.
  • When a mask is provided, the mask dimensions must match the input image dimensions.
  • The seed parameter is currently not functional.

Outputs

Output NameDescriptionData Type
imageThe generated image or images.IMAGE
This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! Edit on GitHub

Source fingerprint (SHA-256): dcea500ebbbbfe87f8b0dd2d714cf2356edf2030312c2cc6e41d64bd2ad04ea6