Shape an image
set_image_maskApply an editable circle, ellipse, rounded rectangle, heart, star, hexagon, diamond, arch, shield or organic shape to an exact image. Pass elementId, areaId and imageMask:{shape:'circle'}. Existing Crop, filters and background treatment are retained. Optional normalized content framing preserves image aspect. Preview and saved print artwork use the same shape.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"subject": "<subject>",
"sessionToken": "<sessionToken>",
"requestId": "<requestId>"
},
"name": "set_image_mask"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| options | No | Existing arguments; advanced fields/aliases remain accepted. Supplied design patches can overwrite session content; preview/rendering can fetch public image URLs in those designs. Catalogue/session results include the full designArgumentSchema. | |
| subject | Yes | The exact subject returned by start_design_session. | |
| requestId | Yes | Generate a UUID for a new action. Reuse it only for retrying/polling that same action and payload. A new user edit needs a new UUID. | |
| sessionToken | Yes | The private expiring capability returned by start_design_session. Do not publish it. |