Skip to content
Optiwork API Docs

Edit an image

POST
/ai/image/edit
curl --request POST \
  --url https://ai.work.optidata.cloud/api/ai/image/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image=@file \
  --form 'prompt=Replace the background with a light blue sky.' \
  --form mask=@file

Changes an existing image as described in prompt and returns the result as base64 PNG. Optionally send a mask: a PNG of the same size whose fully transparent pixels mark the area to change.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typemultipart/form-data
object
image
required

The image to edit. PNG, up to 4 MB.

string format: binary
prompt
required

The change to make.

string
mask

Optional PNG mask, same size as image, up to 4 MB.

string format: binary

Responses

Section titled “ Responses ”

200

Section titled “200”

The image, base64-encoded.

Media typeapplication/json
object
id
required

Id of this request.

string
url
required

Always null; the image is returned inline.

string | null
image_base64
required

The PNG image, base64-encoded.

string
Examples
Exampleimage
{
  "id": "a30508a1-7c2e-4b1d-9f3a-0e6d5c4b3a21",
  "url": null,
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAA…"
}

401

Section titled “401”

No authentication key was sent.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Exampleexpired
{
  "error": "JWT passport expired: Passport expired"
}

422

Section titled “422”

A required field is missing, or a file is not a PNG.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
{
  "message": "The image field is required. (and 1 more error)",
  "errors": {
    "image": [
      "The image field is required."
    ],
    "prompt": [
      "The prompt field is required."
    ]
  }
}