Create Image Variation

POST /images/variations

cURL

Default

curl https://api.portkey.ai/v1/images/variations \ -H "x-portkey-api-key: $PORTKEY_API_KEY" \ -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \ -F image="@otter.png" \ -F n=2 \ -F size="1024x1024"

200

{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "url": "<string>",
      "revised_prompt": "<string>"
    }
  ]
}

Authorizations

Portkey-Key & Virtual-KeyPortkey-Key & Provider-Auth & Provider-NamePortkey-Key & ConfigPortkey-Key & Provider-Auth & Provider-Name & Custom-Host

x-portkey-api-key · string · header · required

x-portkey-virtual-key · string · header · required

Body

multipart/form-data

image · file · required

The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

model · string enum<string> · default: dall-e-2

The model to use for image generation. Only dall-e-2 is supported at this time.

Example:

"dall-e-2"

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

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.

Available options: 256x256, 512x512, 1024x1024

Example:

"1024x1024"

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

Show child attributes