Elysia Tools Docs
EN
Language
ZHESPTRUFRDEEN
Back to site
Browse tools

Design

Image Masking Effect

Apply masking effects to images using shapes, gradients, or custom masks for creative compositions

file· File resultOpen tool

Quick start

Call this tool from your code in three languages.

cURL
# 1) Request a presigned URL → returns { uploadUrl, storageKey }
curl -X POST 'https://api.elysiatools.com/api/upload/presign/image-add-masking' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"imageFile.ext","contentType":"application/octet-stream","size":12345}'

# 2) PUT the file bytes directly to the presigned uploadUrl
curl -X PUT '<presigned uploadUrl>' \
  --data-binary @/path/to/file.ext

# 3) Call the tool, passing the returned storageKey for each file field
curl -X POST 'https://api.elysiatools.com/en/api/tools/image-add-masking' \
  -F 'imageFile=uploads/2026/01/01/your-tool-1700000000000-abc123.ext' \
  -F 'maskType=shape' \
  -F 'maskShape=circle' \
  -F 'maskPosition=center' \
  -F 'maskSize=80' \
  -F 'featherRadius=0' \
  -F 'invertMask=false' \
  -F 'outputFormat=png' \
  -F 'quality=90'

© 2026 Elysia Tools. Developer documentation.

Back to siteBrowse tools

API reference

Send a POST request with your inputs as JSON. File parameters require a separate upload first.

Endpoint

HTTP
POST https://api.elysiatools.com/en/api/tools/image-add-masking

Parameters

NameTypeRequiredDescription
imageFilefileupload requiredYesImage to apply masking effect
maskTypeselectNoType of mask to apply
maskShapeselectNoShape of the mask (when mask type is shape)
maskPositionselectNoPosition of the mask
maskSizenumberNoSize of the mask as percentage of image dimensions
featherRadiusnumberNoSoft edge radius for the mask (0 for hard edges)
invertMaskcheckboxNoInvert the mask effect (hide masked area instead of showing it)
outputFormatselectNoOutput format for the result image
qualitynumberNoOutput quality for lossy formats
File-type parameters must be uploaded first via POST /upload/image-add-masking, then the returned filePath is passed to the corresponding file field.

Response format

File result

JSON
{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}

MCP integration

Add this tool to your Model Context Protocol server so AI agents can list and call it.

Server configuration

Add this block to your MCP client configuration:

mcp.json
{
  "mcpServers": {
    "elysiatools-image-add-masking": {
      "name": "image-add-masking",
      "description": "Apply masking effects to images using shapes, gradients, or custom masks for creative compositions",
      "baseUrl": "https://api.elysiatools.com/mcp/sse?toolId=image-add-masking",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

List available tools

After connecting to the SSE endpoint, list the exposed tools:

tools/list
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

Call this tool

Invoke the tool by its id, passing arguments built from its parameters:

tools/call
{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "image-add-masking",
    "arguments": {
  "imageFile": "https://example.com/file.ext",
  "maskType": "shape",
  "maskShape": "circle",
  "maskPosition": "center",
  "maskSize": 80,
  "featherRadius": 0,
  "invertMask": false,
  "outputFormat": "png",
  "quality": 90
}
  }
}
Chain multiple tools in one session with a comma-separated toolId list, e.g. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (max 20).
File parameters accept a public file URL only (https://…). Local paths, data: URIs, and Base64 strings are not supported.

Questions or issues? Contact [email protected]

Browse tools
Open tool