Skip to main content
POST
/
images
/
generations
curl https://api.portkey.ai/v1/images/generations \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
  -d '{
    "model": "dall-e-3",
    "prompt": "A cute baby sea otter",
    "n": 1,
    "size": "1024x1024"
  }'
{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "url": "<string>",
      "revised_prompt": "<string>"
    }
  ]
}

Authorizations

​
x-portkey-api-key
string
header
required
​
x-portkey-virtual-key
string
header
required

Body

application/json
​
prompt
string
required

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
default:dall-e-2

The model to use for image generation.

Example:

"dall-e-3"

​
n
integer | null
default:1

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

Required range: 1 <= x <= 10
Example:

1

​
quality
enum<string>
default:standard

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.

Available options:
standard,
hd
Example:

"standard"

​
response_format
enum<string> | null
default:url

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.

Available options:
url,
b64_json
Example:

"url"

​
size
enum<string> | null
default:1024x1024

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.

Available options:
256x256,
512x512,
1024x1024,
1792x1024,
1024x1792
Example:

"1024x1024"

​
style
enum<string> | null
default:vivid

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.

Available options:
vivid,
natural
Example:

"vivid"

​
user
string

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

OK

​
created
integer
required
​
data
object[]
required
⌘I