edit-workflow

Product Color Change

Recolors the masked regions of the product photo, each to its own target color, while preserving the product's geometry, materials, prints, logos, and shading, and keeping every region outside the masks 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 as raw image bytes via multipart/form-data.

Supply the masks marking the regions to recolor as raw masks bytes, paired by position with colors — up to 4 regions; a single-region edit is a one-item list. Every mask must have the same pixel dimensions as the product photo. White pixels mark the region to recolor; black pixels are preserved. Alpha-only masks are also supported: opaque pixels mark the region to recolor and transparent pixels are preserved.

post/v2/tool/colorways

Headers

Api-Keystring required

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

Response

Colorway accepted for asynchronous processing.

generation_idstring required

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

Changes