NAnaga
Images

Edit an image

Changed on

Edits uploaded images against a text prompt and charges the account for what it counted. Requires an API key. /v1/images/generations draws from a prompt alone.

post/v1/images/edits

Request

Request body multipart/form-data

modelstring required

The model to edit with, named by its id or alias.

promptstring required

What to change, in words. One to 32000 characters.

imagestring[] required

The images to edit, one per part named image; image[] merges into the same list.

backgroundstring nullable

The provider's background knob, passed through unchecked. A provider without one drops it.

maskstring binary nullable

A single image whose transparent area marks what the model may repaint.

ninteger nullable

How many images to ask for. Absent means one; a value above what the model declares draws a refusal.

qualitystring nullable

The provider's quality knob, passed through unchecked. A provider without one drops it.

response_format'url' | 'b64_json'

How the produced images are handed back.

sizestring nullable

The requested image size, written {width}x{height}; any other shape draws a refusal.

Response

The edited images, in the same body POST /v1/images/generations answers with.

createdinteger required

When the gateway rendered this body, in seconds since the Unix epoch.

Changes

  • b697d49fa1f9Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property became required

    • breaking

      the request property contentMediaType changed from application/octet-stream to

    • breaking

      the request property contentMediaType changed from to application/octet-stream

    • breaking

      removed the enum value b64_json of the request property

    • breaking

      removed the enum value url of the request property

    • breaking

      request property list-of-types was narrowed by removing types null from media type multipart/form-data

    • breaking

      the request property type changed from string to array

    • breaking

      the request property type changed from integer to integer null, and format from no format to int64

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id editImage removed and replaced with create_image_edit

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property's minLength was decreased from 1 to 0

    • info

      the request property type was generalized from string to no type

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added the required property to the response with the status