Skip to main content
POST
/
api
/
{workspaceID}
/
v1
/
images
/
edits
Edit images
curl --request POST \
  --url https://ai.liara.ir/api/{workspaceID}/v1/images/edits \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'image=<string>' \
  --form 'prompt=<string>' \
  --form 'model=<string>' \
  --form mask='@example-file' \
  --form 'input_fidelity=<string>' \
  --form n=1 \
  --form 'size=<string>' \
  --form 'quality=<string>' \
  --form 'background=<string>' \
  --form output_compression=123 \
  --form partial_images=123 \
  --form 'response_format=<string>' \
  --form stream=true \
  --form 'user=<string>' \
  --form image.items='@example-file'
{
  "id": "<string>",
  "created": 123,
  "data": [
    {
      "url": "<string>",
      "b64_json": "<string>",
      "revised_prompt": "<string>"
    }
  ],
  "usage": {
    "total_cost": 123,
    "total_cost_toman": 123
  }
}

Authorizations

Authorization
string
header
required

Enter the API key with the Bearer: prefix, e.g. "Bearer "

Path Parameters

workspaceID
string
required

The workspace ID

Pattern: ^[a-f0-9]{24}$

Body

multipart/form-data
image
file[]

Input image file(s) - up to 16 files

prompt
string

Text description of the desired edit

model
string

Image model ID (same as generations)

mask
file

Mask image for inpainting

input_fidelity
string

Input fidelity setting

n
number
default:1

Number of images to generate

size
string

Image size (same as generations)

quality
string

Image quality (same as generations)

background
string

Background setting

output_format
enum<string>

Output image format

Available options:
png,
jpeg,
webp
output_compression
number

Compression level

partial_images
number

Number of partial images

response_format
string

Response format

stream
boolean

Enable streaming

user
string

End-user identifier

Response

Successful response

id
string

Log ID

created
integer<unix-timestamp>
data
object[]
usage
object