Skip to content

image_create_variation_params

Classes:

Name Description
ImageCreateVariationParams

ImageCreateVariationParams

Attributes:

Name Type Description
image Required[FileTypes]

The image to use as the basis for the variation(s).

model Union[str, Literal['dall-e-2'], None]

The model to use for image generation.

n Optional[int]

The number of images to generate.

response_format Optional[Literal['url', 'b64_json']]

The format in which the generated images are returned.

size Optional[Literal['256x256', '512x512', '1024x1024']]

The size of the generated images.

user str

A unique identifier representing your end-user, which can help OpenAI to monitor

image instance-attribute

image: Required[FileTypes]

The image to use as the basis for the variation(s).

Must be a valid PNG file, less than 4MB, and square.

model instance-attribute

model: Union[str, Literal['dall-e-2'], None]

The model to use for image generation.

Only dall-e-2 is supported at this time.

n instance-attribute

The number of images to generate.

Must be between 1 and 10. For dall-e-3, only n=1 is supported.

response_format instance-attribute

response_format: Optional[Literal['url', 'b64_json']]

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.

size instance-attribute

size: Optional[Literal['256x256', '512x512', '1024x1024']]

The size of the generated images.

Must be one of 256x256, 512x512, or 1024x1024.

user instance-attribute

user: str

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