ImageEditParams | /resources/images.ts | openai@v4.38.3

interface ImageEditParams

import { type ImageEditParams } from "https://deno.land/x/openai@v4.38.3/resources/images.ts";

Properties

image: Uploadable

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

prompt: string

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

optional

mask: Uploadable

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

optional

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

The model to use for image generation. Only dall-e-2 is supported at this time.

optional

n: number | null

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

optional

response_format: "url" | "b64_json" | null

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.

optional

size:

| "256x256"

| "512x512"

| "1024x1024"

| null

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

optional

user: string

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