Open Dev Kit Documentation :: Open AI :: Request Image

OpenAI.RequestImage(
  Model AI Model Image,
  Quality AI Model Image Quality,
  Style AI Model Image Style,
  Background AI Model Image Background,
  Prompt String,
  Number Integer,
  Width Integer,
  Height Integer,
  Image Basis Image*,
  Image Mask Image*
) AI Result*

Given a prompt and/or an input image, the model will generate a new image at the requested resolution.

Parameters

Model AI Model Image

The model to use.

Quality AI Model Image Quality

The quality to use. Cannot be used with basis/mask.

Style AI Model Image Style

The quality to use (DALL-E 3 only). Cannot be used with basis/mask.

Background AI Model Image Background

Allows to set transparency for the background of the generated image(s) (GPT-Image-1 only).

Prompt String

A text description of the desired image(s). The maximum length is 1000 characters. If left empty, an image variation will be performed.

Number Integer

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

Width Integer

The width of the generated images. Must be one of 0 (auto), 256, 512, 1024, or 1792.

Height Integer

The height of the generated images. Must be one of 0 (auto), 256, 512, 1024, or 1792.

Image Basis Image*

An optional image to use as a basis for an image edit, extension or variation. If mask is not provided and a prompt is provided, image must have transparency, which will be used as the mask (DALL-E 2 only).

Image Mask Image*

An optional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Basis image and prompt must also be specified (DALL-E 2 only).

Return Value

AI Result*

Lua Usage

local aIResult = OpenAI.RequestImage(model, quality, style, background, prompt, number, width, height, imageBasis, imageMask)

If you think anything is missing, please feel free to: submit documentation feedback on this page