Create image

POSThttps:/api.openai.com/v1/images/generations

Creates an image given a prompt. Learn more.

Request body

  • prompt
    string
    Required

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

  • model
    string

    The model to use for image generation. One of dall-e-2, dall-e-3, or gpt-image-1. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

    • model
      string
    • model
      string
      • dall-e-2
        string
      • dall-e-3
        string
      • gpt-image-1
        string
  • n
    integer or null
    Defaults: 1

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

  • quality
    string or null
    Defaults: auto

    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 gpt-image-1.
    • hd and standard are supported for dall-e-3.
    • standard is the only option for dall-e-2.
    • standard
      string
    • hd
      string
    • low
      string
    • medium
      string
    • high
      string
    • auto
      string
  • response_format
    string or null
    Defaults: url

    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 gpt-image-1 which will always return base64-encoded images.

    • url
      string
    • b64_json
      string
  • output_format
    string or null
    Defaults: png

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

    • png
      string
    • jpeg
      string
    • webp
      string
  • output_compression
    integer or null
    Defaults: 100

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

  • size
    string or null
    Defaults: auto

    The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, one of 256x256, 512x512, or 1024x1024 for dall-e-2, and one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3.

    • auto
      string
    • 1024x1024
      string
    • 1536x1024
      string
    • 1024x1536
      string
    • 256x256
      string
    • 512x512
      string
    • 1792x1024
      string
    • 1024x1792
      string
  • moderation
    string or null
    Defaults: auto

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

    • low
      string
    • auto
      string
  • background
    string or null
    Defaults: auto

    Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. 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.

    • transparent
      string
    • opaque
      string
    • auto
      string
  • style
    string or null
    Defaults: vivid

    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.

    • vivid
      string
    • natural
      string
  • user
    string

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

Response

Returns a list of image objects.

Example request
1
curl https://api.openai.com/v1/images/generations \
2
-H "Content-Type: application/json" \
3
-H "Authorization: Bearer $OPENAI_API_KEY" \
4
-d '{
5
"model": "gpt-image-1",
6
"prompt": "A cute baby sea otter",
7
"n": 1,
8
"size": "1024x1024"
9
}'
Example response
1
{
2
"created": 1713833628,
3
"data": [
4
{
5
"b64_json": "..."
6
}
7
],
8
"usage": {
9
"total_tokens": 100,
10
"input_tokens": 50,
11
"output_tokens": 50,
12
"input_tokens_details": {
13
"text_tokens": 10,
14
"image_tokens": 40
15
}
16
}
17
}
Built with