PIpicsart
Effects

Masks

Changed on

The masks service applies a mask to an image.

post/masks

Request

  • Base URL
    https://api.picsart.io/tools/1.0
  • URL
    https://api.picsart.io/tools/1.0/masks
  • Auth
    API key in header X-Picsart-API-Key

Request body multipart/form-data

imagestring binary

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

image_urlstring uri

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

image_idstring

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.)

format'JPG' | 'PNG' | 'WEBP'

Optionally select one of the image formats. Options are as follows:

  • JPG
  • PNG
  • WEBP
blend'normal' | 'screen' | 'overlay' | 'multiply' | 'darken' | 'lighten' | 'add'

Select one of the appearance types from the list (screen is chosen if left blank). The options are as follows:

  • normal
  • screen
  • overlay
  • multiply
  • darken
  • lighten
  • add
mask'lace1' | 'lace2' | 'lace3' | 'lace4' | 'shdw2' | 'shdw17' | 'rpl3' | 'rpl5' | 'prsm3' | 'prsm9' | 'prsm10' required

Select one of the mask types from the list. The options are as follows:

  • lace1
  • lace2
  • lace3
  • lace4
  • shdw2
  • shdw17
  • rpl3
  • rpl5
  • prsm3
  • prsm9
  • prsm10
opacityinteger

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

hueinteger

Enter an integer value from -180 to +180. Default is 0.

mask_flip'left' | 'right' | 'mirror horizontal' | 'mirror vertical' | 'turnaround'

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

  • left
  • right
  • mirror horizontal
  • mirror vertical
  • turnaround

Response

Success.

statusstring

Changes

  • 466238206997Revision changes
    • warning

      the optional response header X-Correlation-Id removed for the status 400

    • warning

      the optional response header X-Correlation-Id removed for the status 401

    • warning

      the optional response header X-Correlation-Id removed for the status 403

    • warning

      the optional response header X-Correlation-Id removed for the status 404

    • warning

      the optional response header X-Correlation-Id removed for the status 405

    • warning

      the optional response header X-Correlation-Id removed for the status 413

    • warning

      the optional response header X-Correlation-Id removed for the status 415

    • warning

      the optional response header X-Correlation-Id removed for the status 429

    • warning

      the optional response header X-Correlation-Id removed for the status 431

    • warning

      the optional response header X-Correlation-Id removed for the status 500

    • warning

      the optional response header X-Correlation-Id removed for the status 503

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property ////

    • info

      added the non-success response with the status