Masking

Generate human item masks

Changed on

This endpoint processes an input image of a human, then identifies and creates masks for various items and sections on the body including sunglasses, hats, upper body apparel, lower body apparel, arms, legs, shoes, and more. The API returns an array of masks corresponding to each detected item and body part.

Granular Labels (New — GA): Set useGranularLabels: true in the request body to receive side-specific masks for bilateral body parts. For example, instead of a single combined mask, the API returns separate masks for Left Shoe and Right Shoe, Left Arm and Right Arm, and so on. This capability is essential for workflows that apply independent effects — such as ground shadows or reflections — to individual limbs at scale.

To check the status of this process, utilize the Get Status - V1 endpoint.

post/v1/mask-body-parts

Request

  • Base URL: https://image.adobe.io
  • URL: https://image.adobe.io/v1/mask-body-parts
  • Auth: HTTP bearer and API key in header x-api-key

Request body

useGranularLabelsboolean

When set to true, the API returns granular side-specific labels for bilateral body parts (e.g., Left Shoe, Right Shoe, Left Arm, Right Arm). When false or omitted, the API returns the default combined label set. See the Granular Labels section of the documentation for the full label reference.

Response

Accepted

jobIdstring required

The job ID for the asynchronous job.

statusUrlstring required

The URL to check the status of the asynchronous job.

Changes