Images

images

Methods

Create Image Variation ->
post/images/variations

Creates a variation of a given image.

Security
Bearer Auth

Example: Authorization: Bearer My API Key

Body parameters
image: string

The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

model?: string |

The model to use for image generation. Only dall-e-2 is supported at this time.

n?: number

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

response_format?: "url" | "b64_json"

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.

size?: "256x256" | "512x512" | "1024x1024"

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

user?: string

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

Response fields
Request example
200Example
Create Image Edit ->
post/images/edits

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

Create Image ->
post/images/generations

Creates an image given a prompt.

Domain types

Image = { b64_json, revised_prompt, url }
ImageModel = "dall-e-2" | "dall-e-3"
ImagesResponse = { created, data }