API reference/POST /studio-shot

E-commerce studio shot

One-call e-commerce preset: cutout, padding, soft drop shadow, neutral background. Tuned for catalog images and Shopify-style product tiles.

POSThttps://useknockout--api.modal.run/studio-shot

Parameters

Send as multipart/form-data unless noted otherwise.

filerequiredfile—Image to process. JPG, PNG, WebP, HEIC. Up to 10 MB and 4096×4096.
bg_colorstring#FFFFFFBackground hex color.
paddingint10%Padding as pixels or % of canvas.
shadowbooleantrueWhether to add a soft drop shadow.
aspectstring1:1Output aspect ratio.

Request

curl -X POST "https://useknockout--api.modal.run/studio-shot" \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@cat.jpg" \
  -F "bg_color=#F9FAFB" \
  -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.

Notes

  • Defaults match Shopify and Amazon catalog requirements: 1:1, white bg, 10% padding.
  • Override aspect to 4:5 for Instagram, 16:9 for desktop catalog headers.
← POST /shadowPOST /headshot →