API reference/POST /compare

Before/after composite

Side-by-side or split-slider before/after preview. Drop into marketing pages, demo widgets, or quality QA tooling.

POSThttps://useknockout--api.modal.run/compare

Parameters

Send as multipart/form-data unless noted otherwise.

filerequiredfile—Image to process. JPG, PNG, WebP, HEIC. Up to 10 MB and 4096×4096.
layoutstringside-by-sideLayout. side-by-side, slider, top-bottom.
label_astringOriginalLabel for the original image.
label_bstringCutoutLabel for the processed image.
formatstringpngOutput format — png (with alpha) or webp.

Request

curl -X POST "https://useknockout--api.modal.run/compare" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@cat.jpg" \
  -F "layout=slider" \
  -o out.png

Response

HTTP/1.1 200 OK
content-type: image/png
content-length: 254312
x-knockout-latency: 184
x-knockout-model: BiRefNet
x-ratelimit-limit: 60
x-ratelimit-remaining: 59

Errors

401unauthorized—Missing or invalid token.
402payment_required—Free tier exhausted. Add a card to continue.
413payload_too_large—Image exceeds 10 MB or 4096×4096.
422no_subject_detected—Foreground could not be isolated from background.
429rate_limit_exceeded—Slow down. Retry-After header tells you when.
500internal_error—Something broke on our side. Include request_id when reporting.
Every error response also includes a request_id in the JSON body. Quote it when reporting issues.
← POST /headshotPOST /upscale →