edit-workflow

Product Material Change

Re-renders the masked region of the product photo in the material shown by the reference image — matching its color, texture, pattern scale, and orientation — while preserving the product's silhouette, construction, seams, and shading, and keeping every region outside the mask unchanged.

The request is processed asynchronously. Poll GET /v1/generations/{generation_id} with the returned generation_id until the generation is completed or failed.

Supply the product photo, the mask marking the region to re-material, and the material reference image as raw bytes (image, mask, and material) via multipart/form-data. The mask must have the same pixel dimensions as the product photo. White pixels mark the region to change; black pixels are preserved. Alpha-only masks are also supported: opaque pixels mark the region to change and transparent pixels are preserved.

post/v2/tool/material-swap

Headers

Api-Keystring required

API key for access control. Use in the header with the name "Api-Key"

Response

Material swap accepted for asynchronous processing.

generation_idstring required

URL-safe base64 ID accepted by the generation polling endpoint.

Changes