upload_idstringrequired
The ID of the Upload.
Example:upload_abc123
Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete).
post
https://api.openai.com/v1/uploads/{upload_id}/parts
Path Parameters
Body
multipart/form-data
Body
multipart/form-data
AddUploadPartRequest
* Additional properties are NOT allowed.
datastringrequired
The chunk of bytes for this Part.
Response
200 application/json
Response
200 application/json
OK
UploadPart
The upload Part represents a chunk of bytes we can add to an Upload object.
idstringrequired
The upload Part unique identifier, which can be referenced in API endpoints.
created_atintegerrequired
The Unix timestamp (in seconds) for when the Part was created.
upload_idstringrequired
The ID of the Upload object that this Part was added to.
objectstringrequired
The object type, which is always upload.part.
Allowed values:upload.part
post/uploads/{upload_id}/parts
Authentication
Path Parameters
Body
{
"data": "data"
}
200 application/json
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
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.
model
Any OfThe 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
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
Authentication
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
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
model
Any OfThe 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
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
Authentication
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
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.
model
Any OfThe 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
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
Authentication
Body
{
"image": "image"
}
200 application/json