Skip to content
Browse all functions

Mask an Image with a Circle Mask

images/maskcircleimage

maskcircleimage (Mask an Image with a Circle Mask) is a 1001fx API function in the group Images: POST https://api.1001fx.com/images/maskcircleimage, 3 credits per call. It works as a ready-made module in Make and n8n or as a plain HTTP call.

3 credits per callHTTP APIn8nMake

Creates an image with a circle mask.

Try it in the 1001fx app

Run maskcircleimage in your browser with your API key – fill the form, click Run and get the answer or the file.

maskcircleimage in the 1001fx app: the form with example values
Mask an Image with a Circle Mask in the 1001fx app

Endpoint

POSThttps://api.1001fx.com/images/maskcircleimage
Header
X-API-KEY: YOURSECRETAPIKEY How to
Content type
multipart/form-data

Parameters

  • radiusnumberrequired

    The radius for your circle

    Min:
    1
    Example:
    50
  • xnumberoptional

    The horizontal position of your circle center. Defaults to 0.

    Default:
    0
    Example:
    25
  • ynumberoptional

    The vertical position of your circle center. Defaults to 0.

    Default:
    0
    Example:
    25
  • filefilerequired

    Image file to be processed.

Examples

Image circle

Returns a circle image

Input

Expects one image file named as file parameter: file
{
  "radius": "100",
  "x": "50",
  "y": "50",
  "files": [
    {
      "name": "1600x900.png",
      "type": "image/png",
      "path": "testdata/images/1600x900.png"
    }
  ]
}

Output · HTTP 200

Result is a single file.
{
  "statusCode": 200,
  "headers": {
    "content-type": "image/png"
  }
}
Show curl command
curl -X POST 'https://api.1001fx.com/images/maskcircleimage' \
  -H 'X-API-KEY: YOURSECRETAPIKEY' \
  -F 'file=@1600x900.png' \
  -F 'radius=100' \
  -F 'x=50' \
  -F 'y=50'

Try maskcircleimage now

Run it in your browser or create a free account and get 100 credits every month.

Changelog

  • 1.0.013.02.2023created
Ask 1001fx