Skip to main content
POST
image.subject.mask

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fileId
string
required

Id of an uploaded file holding the source image, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
resolution
enum<string>
default:full

Output resolution ceiling: 0.25, 1.5, 4, full, or 50 megapixels. Actual limits vary by source; unsupported tiers decline.

Available options:
preview,
medium,
hd,
full,
50-megapixels
crop
boolean
default:false

Crop the mask around the detected subject; false keeps original framing.

despill
boolean
default:false

Remove green-screen colour reflections when supported; false by default.

foreground
enum<string>
default:auto

Foreground category to segment, or automatic selection. This selects content rather than identifying a person.

Available options:
auto,
car,
product,
person,
animal,
graphic,
transportation

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.