upload_idstringrequired
The ID of the Upload.
Example:upload_abc123
Cancels the Upload. No Parts may be added after an Upload is cancelled.
post
https://api.openai.com/v1/uploads/{upload_id}/cancel
Path Parameters
Response
200 application/json
Response
200 application/json
OK
Upload
The Upload object can accept byte chunks in the form of Parts.
idstringrequired
The Upload unique identifier, which can be referenced in API endpoints.
created_atintegerrequired
The Unix timestamp (in seconds) for when the Upload was created.
filenamestringrequired
The name of the file to be uploaded.
bytesintegerrequired
The intended number of bytes to be uploaded.
purposestringrequired
The intended purpose of the file. Please refer here for acceptable values.
statusstringrequired
The status of the Upload.
Allowed values:pendingcompletedcancelledexpired
expires_atintegerrequired
The Unix timestamp (in seconds) for when the Upload was created.
objectstring
The object type, which is always “upload”.
Allowed values:upload
file
The ready File object after the Upload is completed.
Show Child Parameters
post/uploads/{upload_id}/cancel
Authentication
Path Parameters
200 application/json
Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
post
https://api.openai.com/v1/uploads/{upload_id}/complete
Path Parameters
upload_idstringrequired
The ID of the Upload.
Example:upload_abc123
Body
application/json
Body
application/json
CompleteUploadRequest
* Additional properties are NOT allowed.
part_idsarray[string]required
The ordered list of Part IDs.
md5string
The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
Response
200 application/json
Response
200 application/json
OK
Upload
The Upload object can accept byte chunks in the form of Parts.
idstringrequired
The Upload unique identifier, which can be referenced in API endpoints.
created_atintegerrequired
The Unix timestamp (in seconds) for when the Upload was created.
filenamestringrequired
The name of the file to be uploaded.
bytesintegerrequired
The intended number of bytes to be uploaded.
purposestringrequired
The intended purpose of the file. Please refer here for acceptable values.
statusstringrequired
The status of the Upload.
Allowed values:pendingcompletedcancelledexpired
expires_atintegerrequired
The Unix timestamp (in seconds) for when the Upload was created.
objectstring
The object type, which is always “upload”.
Allowed values:upload
file
The ready File object after the Upload is completed.
Show Child Parameters
post/uploads/{upload_id}/complete
Authentication
Path Parameters
Body
{
"part_ids": [
"[]"
]
}
200 application/json
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
upload_idstringrequired
The ID of the Upload.
Example:upload_abc123
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