Search
K
OpenAI API

Images

Given a prompt and/or an input image, the model will generate a new image.

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

post
https://api.openai.com/v1/images/edits

Body

multipart/form-data

CreateImageEditRequest

imagestringrequired

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

promptstringrequired

A text description of the desired image(s). The maximum length is 1000 characters.

Example:A cute baby sea otter wearing a beret

maskstring

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

modelAny Of

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

Default:dall-e-2

Example:dall-e-2

Variant 1string
ninteger | null

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

Default:1

>= 1<= 10

Example:1

sizestring | null

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

Allowed values:256x256512x5121024x1024

Default:1024x1024

Example:1024x1024

response_formatstring | null

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.

Allowed values:urlb64_json

Default:url

Example:url

userstring

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

Example:user-1234

Response

200 application/json

OK

ImagesResponse

createdintegerrequired
dataarray[object]required

Represents the url or the content of an image generated by the OpenAI API.

Show Child Parameters
post/images/edits

Body

{ "image": "image", "prompt": "A cute baby sea otter wearing a beret" }
 
200 application/json

Creates an image given a prompt.

post
https://api.openai.com/v1/images/generations

Body

application/json

CreateImageRequest

promptstringrequired

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.

Example:A cute baby sea otter

modelAny Of

The model to use for image generation.

Default:dall-e-2

Example:dall-e-3

Variant 1string
ninteger | null

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

Default:1

>= 1<= 10

Example:1

qualitystring

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

Allowed values:standardhd

Default:standard

Example:standard

response_formatstring | null

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.

Allowed values:urlb64_json

Default:url

Example:url

sizestring | null

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 for dall-e-3 models.

Allowed values:256x256512x5121024x10241792x10241024x1792

Default:1024x1024

Example:1024x1024

stylestring | null

The style of the generated images. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for dall-e-3.

Allowed values:vividnatural

Default:vivid

Example:vivid

userstring

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

Example:user-1234

Response

200 application/json

OK

ImagesResponse

createdintegerrequired
dataarray[object]required

Represents the url or the content of an image generated by the OpenAI API.

Show Child Parameters
post/images/generations

Body

{ "prompt": "A cute baby sea otter" }
 
200 application/json

Creates a variation of a given image.

post
https://api.openai.com/v1/images/variations

Body

multipart/form-data

CreateImageVariationRequest

imagestringrequired

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

modelAny Of

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

Default:dall-e-2

Example:dall-e-2

Variant 1string
ninteger | null

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

Default:1

>= 1<= 10

Example:1

response_formatstring | null

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.

Allowed values:urlb64_json

Default:url

Example:url

sizestring | null

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

Allowed values:256x256512x5121024x1024

Default:1024x1024

Example:1024x1024

userstring

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

Example:user-1234

Response

200 application/json

OK

ImagesResponse

createdintegerrequired
dataarray[object]required

Represents the url or the content of an image generated by the OpenAI API.

Show Child Parameters
post/images/variations

Body

{ "image": "image" }
 
200 application/json

Models

List and describe the various models available in the API.