Cutout

Cut a product out of its photo

A product photo in, the product cut out: a transparent PNG — or the product on a new background (a colour or a picture) — with the product's tight box (cutout.box, pixels of the result before any crop) and, on request, the mask (mask: true → cutout.mask_url). crop: true crops the result to the product plus padding. Glass, fur, white on white and shadows are handled; a shadow on the surface is left out. With a background the plain transparent cutout is returned too (cutout.cutout_url) — the same product for another background, or as a video overlay (overlays[] with mode: "pip" and shadow: true in POST /v1/studio/edit). Photos up to 64 megapixels; the result's long side is at most 4096 px. Asynchronous: poll GET /v1/executions/{id}.

Billing: One picture through the cutout model, priced by its measured compute (tier cutout). Failed cutouts are not charged. · Rate limit: 30/min · Asynchronous

post/v1/studio/cutout

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/studio/cutout
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

x-wait-msinteger

Wait for the job inside this call (ms)

Request body

cropboolean

Crop the result to the product, plus padding

maskboolean

Also return the mask: a black-and-white PNG (white = the product) at cutout.mask_url

format'png' | 'jpg'

png = transparent (the default without a background); jpg = smaller (the default with a background; needs one)

paddingnumber

With crop: room around the product, as a share of its larger side

image_urlstring uri required

Public URL of the product photo (JPEG, PNG or WebP) — or the url of a previous render

Response

Completed (or 202 while processing)

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.