Add shape
snipaya_add_shapeOverlay a rectangle, ellipse, highlighter, blur, or noise block on a region to annotate screenshots or hide sensitive data safely.
Instructions
Add a rectangle frame, ellipse, highlighter box, blur (pixelate) or noise (opaque random colors from the area, the safest way to hide sensitive data) over a region. For blur and noise, pixelSize sets the block size; larger is coarser.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| rect | Yes | A rectangle (top-left corner plus size). Canvas units, or image pixels with relativeTo. | |
| style | No | Optional style. Omitted fields use the user’s current tool style. Brand colors: coral #EC534E, papaya #FE9440. | |
| tabId | No | Target tab id. Defaults to the active tab. | |
| pixelSize | No | Blur or noise block size in the units of rect. Defaults to the user’s Blur or Noise tool size. | |
| relativeTo | No | Image id from snipaya_get_canvas. When set, all coordinates in this call are pixels of that image as captured (the same pixels you see in snipaya_render of that image). |