images_edit_request {oaii}

API images: edit request

Description

Creates an edited or extended image given an original image and a prompt. To get more details, visit https://platform.openai.com/docs/api-reference/images/edits

Usage

images_edit_request(
  image,
  prompt,
  mask = NULL,
  model = NULL,
  n = NULL,
  size = NULL,
  response_format = NULL,
  user = NULL,
  api_key = api_get_key()
)

Arguments

image

string/raw, 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.

mask

NULL/string/raw, 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

NULL/string, the model to use for image generation. Only dall-e-2 is supported at this time.

n

NULL/int, the number of images to generate. Must be between 1 (default) and 10.

size

NULL/string, the size of the generated images. Must be one of 256x256, 512x512, or 1024x1024 (default).

response_format

NULL/string, the format in which the generated images are returned. Must be one of "url" or "b64_json".

user

string a unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

api_key

string, OpenAI API key (see https://platform.openai.com/account/api-keys)

Value

content of the httr response object or SimpleError (conditions) enhanced with two additional fields: 'status_code' (response$status_code) and 'message_long' (built on response content)