import { CreateImageEditRequest } from "argot-open-ai/models/components";
// No examples available for this model
Field | Type | Required | Description | Example |
---|---|---|---|---|
image |
File | Blob | components.CreateImageEditRequestImage | ✔️ | 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. | A cute baby sea otter wearing a beret |
mask |
File | Blob | components.Mask | ➖ | 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 . |
|
model |
components.CreateImageEditRequestModel | ➖ | The model to use for image generation. Only dall-e-2 is supported at this time. |
dall-e-2 |
n |
number | ➖ | The number of images to generate. Must be between 1 and 10. | 1 |
responseFormat |
components.CreateImageEditRequestResponseFormat | ➖ | 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. |
url |
size |
components.CreateImageEditRequestSize | ➖ | The size of the generated images. Must be one of 256x256 , 512x512 , or 1024x1024 . |
1024x1024 |
user |
string | ➖ | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. |
user-1234 |