Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/src/types.ts>ImageEditOptions

Unofficial Deno wrapper for the Open Ai api
Extremely Popular
Go to Latest
interface ImageEditOptions
import { type ImageEditOptions } from "https://deno.land/x/openai@1.3.3/src/types.ts";

Properties

image: string

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. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-image

optional
mask: string

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. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-mask

prompt: string

A text description of the desired image(s). The maximum length is 1000 characters. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-prompt

optional
n: number

The number of images to generate. Must be between 1 and 10. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-n

optional
size: "256x256" | "512x512" | "1024x1024"

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-size

optional
responseFormat: "url" | "b64_json"

The format in which the generated images are returned. Must be one of url or b64_json. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-response_format

optional
user: string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. https://platform.openai.com/docs/api-reference/images/create-edit#images/create-edit-user