INinferera
OpenAI · Images

/v1/images/generations

Creates an image given a prompt. Learn more.

post/v1/images/generations

Request

Request body

promptstring required

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

ninteger nullable

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

quality'standard' | 'hd' | 'low' | 'medium' | 'high' | 'auto' nullable

The quality of the image that will be generated.

  • auto (default value) will automatically select the best quality for the given model.
  • high, medium and low are supported for the GPT image models.
  • hd and standard are supported for dall-e-3.
  • standard is the only option for dall-e-2.
response_format'url' | 'b64_json' nullable

The format in which generated images with dall-e-2 and dall-e-3 are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.

output_format'png' | 'jpeg' | 'webp' nullable

The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp.

output_compressioninteger nullable

The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.

streamboolean nullable

Generate the image in streaming mode. Defaults to false. See the Image generation guide for more information. This parameter is only supported for the GPT image models.

partial_imagesinteger nullable

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

moderation'low' | 'auto' nullable

Control the content-moderation level for images generated by the GPT image models. Must be either low for less restrictive filtering or auto (default value).

background'transparent' | 'opaque' | 'auto' nullable

Allows to set transparency for the background of the generated image(s). This parameter is only supported for the GPT image models. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image.

If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

style'vivid' | 'natural' nullable

The style of the generated images. This parameter is only supported for dall-e-3. 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.

userstring

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

Example request

{
  "prompt": "A cute baby sea otter",
  "n": 1,
  "quality": "medium",
  "response_format": "url",
  "output_format": "png",
  "output_compression": 100,
  "partial_images": 1,
  "moderation": "low",
  "background": "transparent",
  "style": "vivid",
  "user": "user-1234"
}

Response

OK

createdinteger required

The Unix timestamp (in seconds) of when the image was created.

background'transparent' | 'opaque'

The background parameter used for the image generation. Either transparent or opaque.

output_format'png' | 'webp' | 'jpeg'

The output format of the image generation. Either png, webp, or jpeg.

size'1024x1024' | '1024x1536' | '1536x1024'

The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.

quality'low' | 'medium' | 'high'

The quality of the image generated. Either low, medium, or high.

Changes

No recorded changes to this operation across all 1 revision of this API.