🖼️ Images Official Documentation

⋙ Create Image

Creates an image given a prompt.

msg.payload Properties

prompt string
A text description of the desired image(s).
model string
The model to use for image generation.
n integer
The number of images to generate.
quality string
The quality of the image that will be generated.
response_format string
The format in which the generated images are returned. Must be one of url or b64_json.
size string
The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 for dall-e-2. Must be one of 1024x1024, 1792x1024, or 1024x1792.
style string
The style of the generated images. Must be one of vivid or natural.
user string
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

⋙ Create Image Edit

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

msg.payload Properties

image string
The image to edit.
prompt string
A text description of the desired image(s).
mask string
An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited.
model
The model to use for image generation.
n integer
The number of images to generate. Must be between 1 and 10.
size string
The size of the generated images.
response_format string
The format in which the generated images are returned. Must be one of url or b64_json.
user string
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

⋙ Create Image Variation

Creates a variation of a given image.

msg.payload Properties

image string
The image to use as the basis for the variation(s).
model
The model to use for image generation.
n integer
The number of images to generate.
response_format string
The format in which the generated images are returned.
size string
The size of the generated images.
user string
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.