Skip to main content
Module

x/openai/resources/images.ts>ImageGenerateParams

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
interface ImageGenerateParams
import { type ImageGenerateParams } from "https://deno.land/x/openai@v4.21.0/resources/images.ts";

Properties

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.

optional
model:
| (string & { })
| "dall-e-2"
| "dall-e-3"
| null

The model to use for image generation.

optional
n: number | null

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

optional
quality: "standard" | "hd"

The quality of the image that will be generated. hd creates images with finer details and greater consistency across the image. This param is only supported for dall-e-3.

optional
response_format: "url" | "b64_json" | null

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

optional
size:
| "256x256"
| "512x512"
| "1024x1024"
| "1792x1024"
| "1024x1792"
| null

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 models.

optional
style: "vivid" | "natural" | null

The style of the generated images. Must be one of vivid or natural. 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. This param is only supported for dall-e-3.

optional
user: string

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