API Reference
Console

Mask Previews

post
https://api.picsart.io/tools/1.0/masks/previews

The masks previews service applies mask effects to a given input image and returns a preview (i.e., thumbnail) of the effect.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file

Source image file (binary). (If this parameter is present, the other image source parameters must be empty.)

uri
length between 1 and 2083

Source image URL. (If this parameter is present, the other image source parameters must be empty.)

string
deprecated

Deprecated. Source image ID of an image previously uploaded to Picsart or result image ID from a different API. (If this parameter is present, the other image source parameters must be empty.)

string
enum
Defaults to PNG

Optionally select one of the image formats (JPG is chosen if left blank). Options are as follows:

  • JPG
  • PNG
  • WEBP
Allowed:
string
enum
Defaults to screen

Select one of the appearance types from the list (it will be screen if left blank). The options are as follows.

  • normal
  • screen
  • overlay
  • multiply
  • darken
  • lighten
  • add
Allowed:
mask
array of strings
required
length ≥ 1

Select up to 10 mask types from the list. The options are as follows

  • lace1
  • lace2
  • lace3
  • lace4
  • shdw2
  • shdw17
  • rpl3
  • rpl5
  • prsm3
  • prsm9
  • prsm10
mask*
integer
0 to 100
Defaults to 100

Enter an integer value from 0 to +100. The larger the number, the greater the opacity.

integer
-180 to 180
Defaults to 0

Enter an integer value from -180 to +180.

string
enum

Choose a mask flip option. The choices are as follows.

  • left
  • right
  • mirror horizontal
  • mirror vertical
  • turnaround
Allowed:
integer
Defaults to 120

Enter the max size for the width or height of the preview image. The max value is 240px. If left blank it's 120px.

Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago