Edit image

Edits an image given a prompt and source image.

POST /api/ai/images/edit

Edit image

cURL

curl --request POST \
  --url https://dev.hub.oxen.ai/api/ai/images/edit \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "<string>",
  "model": "<string>",
  "prompt": "<string>",
  "mask": "<string>",
  "n": 1,
  "size": "<string>"
}
'

200

{
  "created": 123,
  "images": [
    {
      "revised_prompt": "<string>",
      "url": "<string>"
    }
  ],
  "model": "<string>"
}

Body

application/json

Image edit request

image · string · required

URL of the source image

model · string · required

prompt · string · required

Text instruction for the edit

mask · string | null

URL of the mask image

n · integer · default: 1

size · string | null

Response

200

application/json

Edited images

created · integer

images · object[]

Show child attributes

model · string