Search
K
OpenAI API

CreateImageEditRequest

object
imagestring(binary)required

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(binary)

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

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

Default:1

>= 1<= 10

Example:1

sizestring

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

Allowed values:256x256512x5121024x1024

Default:1024x1024

Example:1024x1024

response_formatstring

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

Example

CreateImageRequest

object
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

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

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

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

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

Example

CreateImageVariationRequest

object
imagestring(binary)required

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

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

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

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

Example

CreateMessageRequest

object
* Additional properties are NOT allowed.
rolestringrequired

The role of the entity that is creating the message. Allowed values include:

  • user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.
  • assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.

Allowed values:userassistant

contentOne Of
required
Text contentstring

The text contents of the message.

attachmentsarray[object]

A list of files attached to the message, and the tools they should be added to.

Show Child Parameters
metadataobject

Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.

Example

CreateModerationRequest

object
inputOne Of
required

Input (or inputs) to classify. Can be a single string, an array of strings, or
an array of multi-modal input objects similar to other models.

Variant 1string

A string of text to classify for moderation.

Default:

Example:I want to kill them.

modelAny Of

The content moderation model you would like to use. Learn more in
the moderation guide, and learn about
available models here.

Default:omni-moderation-latest

Example:omni-moderation-2024-09-26

Variant 1string
Example