Specs

create_image_variation(bitstring(),
  openai_organization_key: String.t(),
  openai_api_key: String.t(),
  user: String.t(),
  size: :"1024x1024" | :"512x512" | :"256x256",
  response_format: :b64_json | :url,
  n: integer(),
  stream_to: pid()
) :: {:ok, ExOpenAI.Components.ImagesResponse.t()} | {:error, any()}

Creates a variation of a given image.

Endpoint: https://api.openai.com/v1/images/variations

Method: POST

Docs: https://platform.openai.com/docs/api-reference/images

Required Arguments:

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

Optional Arguments:

• stream_to: PID of the process to stream content to

• n: The number of images to generate. Must be between 1 and 10.

Example: 1

• response_format: The format in which the generated images are returned. Must be one of url or b64_json.

Example: "url"

• size: The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

Example: "1024x1024"

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

Example: "user-1234"

• openai_api_key: OpenAI API key to pass directly. If this is specified, it will override the api_key config value.

• openai_organization_key: OpenAI API key to pass directly. If this is specified, it will override the organization_key config value.