Skip to main content

openai.createimageprops

Home > @runlightyear/openai > CreateImageProps

CreateImageProps interface

Signature:
interface CreateImageProps 

Required Properties

PropertyModifiersTypeDescription
promptstringA text description of the desired image(s). The maximum length is 1000 characters.

Optional Properties

PropertyModifiersTypeDescription
n?number

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

Defaults to 1

responseFormat?"url" | "b64_json"

The format in which the generated images are returned.

Defaults to url

size?"256x256" | "512x512" | "1024x1024"

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

Defaults to 1024x1024

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