Skip to main content
POST
/
v1
/
images
/
edits
Edit an image
curl --request POST \
  --url http://localhost:8080/v1/images/edits \
  --header 'Content-Type: multipart/form-data' \
  --form 'model=<string>' \
  --form image='@example-file' \
  --form 'prompt=<string>' \
  --form mask='@example-file' \
  --form type=inpainting \
  --form n=5 \
  --form size=256x256 \
  --form response_format=url \
  --form stream=false \
  --form background=transparent \
  --form input_fidelity=low \
  --form partial_images=1 \
  --form quality=auto \
  --form output_format=png \
  --form num_inference_steps=123 \
  --form seed=123 \
  --form output_compression=50 \
  --form 'negative_prompt=<string>' \
  --form 'user=<string>' \
  --form 'fallbacks={
  "provider": "openai",
  "model": "<string>"
}'
{
  "id": "<string>",
  "created": 123,
  "model": "<string>",
  "data": [
    {
      "url": "<string>",
      "b64_json": "<string>",
      "revised_prompt": "<string>",
      "index": 123
    }
  ],
  "background": "<string>",
  "output_format": "png",
  "quality": "<string>",
  "size": "256x256",
  "usage": {
    "input_tokens": 123,
    "input_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    },
    "total_tokens": 123,
    "output_tokens": 123,
    "output_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    }
  },
  "extra_fields": {
    "request_type": "<string>",
    "provider": "openai",
    "model_requested": "<string>",
    "model_deployment": "<string>",
    "latency": 123,
    "chunk_index": 123,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "<string>",
      "hit_type": "<string>",
      "provider_used": "<string>",
      "model_used": "<string>",
      "input_tokens": 123,
      "threshold": 123,
      "similarity": 123
    }
  }
}

Body

multipart/form-data
model
string
required

Model identifier in format provider/model

image
file
required

Image file to edit. Use field name image for a single file or image[] for multiple files.

prompt
string

Text prompt describing the edit. Required unless type is background_removal.

mask
file

Optional mask image for inpainting (transparent areas indicate regions to edit)

type
enum<string>

Type of edit operation

Available options:
inpainting,
outpainting,
background_removal
n
integer

Number of images to generate

Required range: 1 <= x <= 10
size
enum<string>

Size of the output image

Available options:
256x256,
512x512,
1024x1024,
1536x1024,
1024x1536,
auto
response_format
enum<string>
default:url

Format of the response

Available options:
url,
b64_json
stream
boolean
default:false

When true, stream the response via Server-Sent Events

background
enum<string>

Background type for the image

Available options:
transparent,
opaque,
auto
input_fidelity
enum<string>

How closely to follow the original image

Available options:
low,
high
partial_images
integer

Number of partial images to generate when streaming

Required range: 0 <= x <= 3
quality
enum<string>

Quality of the output image

Available options:
auto,
high,
medium,
low,
standard
output_format
enum<string>

Output image format

Available options:
png,
webp,
jpeg
num_inference_steps
integer

Number of inference steps

seed
integer

Seed for reproducible editing

output_compression
integer

Compression level (0-100%)

Required range: 0 <= x <= 100
negative_prompt
string

What to avoid in the edit

user
string

User identifier for tracking

fallbacks
object[]

Fallback models to try if primary model fails

Response

Successful response. Returns JSON for non-streaming requests, or Server-Sent Events (SSE) stream when stream=true. When streaming, events are sent with the following event types:

  • image_edit.partial_image: Intermediate image chunks with base64-encoded image data
  • image_edit.completed: Final event for each image with usage information
  • error: Error events with error details
id
string

Unique identifier for the generation request

created
integer<int64>

Unix timestamp when the image was created

model
string

Model used for generation

data
object[]

Array of generated images

background
string

Background type for the image

output_format
enum<string>

Output image format

Available options:
png,
webp,
jpeg
quality
string

Quality of the generated image

size
enum<string>

Size of the generated image

Available options:
256x256,
512x512,
1024x1024,
1792x1024,
1024x1792,
1536x1024,
1024x1536,
auto
usage
object
extra_fields
object

Additional fields included in responses