CreateImageRequestBody

Request parameters for generating images. Based on the OpenAI Images API. Creates one or more images from a text prompt.

Example Usage

import { CreateImageRequestBody } from "@meetkai/mka1/models/operations";

let value: CreateImageRequestBody = {
  prompt: "<value>",
};

Fields

Field	Type	Required	Description
model	string	➖	The model to use for image generation. Defaults to 'dall-e-2'. Available models include 'dall-e-2' and 'dall-e-3'.
prompt	string	✔️	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.
n	number	➖	The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported. Defaults to 1.
quality	operations.Quality	➖	The quality of the image that will be generated. 'hd' creates images with finer details and greater consistency (only available for dall-e-3). Defaults to 'standard'.
responseFormat	operations.CreateImageResponseFormat	➖	The format in which the generated images are returned. 'url' returns a URL to the image, 'b64_json' returns the image as a base64-encoded JSON string. Defaults to 'url'.
size	operations.Size	➖	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. Defaults to 1024x1024.
style	operations.Style	➖	The style of the generated images (only for dall-e-3). '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. Defaults to 'vivid'.
user	string	➖	A unique identifier representing your end-user, which can help monitor and detect abuse.