PIpicsart
Effects

Effect Previews

Changed on

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

post/effects/previews

Request

  • Base URL
    https://api.picsart.io/tools/1.0
  • URL
    https://api.picsart.io/tools/1.0/effects/previews
  • 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.)

effect_namesstring[] required

Select up to 10 effects. The list of effects are as follows:

  • 1972
  • apr1
  • apr2
  • apr3
  • blur
  • gblur
  • lensblur
  • motionblur
  • smartblur
  • pixelize
  • brl1
  • brnz1
  • brnz2
  • brnz3
  • brnz4
  • cyber1
  • cyber2
  • dodger
  • fattal2
  • food1
  • food2
  • icy1
  • icy2
  • icy3
  • light1
  • light2
  • light3
  • light4
  • light5
  • light6
  • light7
  • light8
  • light9
  • light10
  • light11
  • light12
  • light13
  • light14
  • light15
  • light16
  • light17
  • light18
  • light19
  • light20
  • mnch1
  • mnch2
  • mnch3
  • nature1
  • nature2
  • noise
  • ntrl1
  • ntrl2
  • popart
  • saturation
  • sft1
  • sft2
  • sft3
  • sft4
  • shadow1
  • shadow2
  • sketch1
  • sketch2
  • sketch3
  • sketcher1
  • sketcher2
  • spc1
  • tl1
  • tl2
  • urban1
  • urban2
  • water1
  • water2 You can provide the values as a list, but also as a comma separated string, e.g. "apr1, apr2".
preview_sizeinteger

Enter the width of the preview image. The max value is 240px. The default is 120px.

fadeinteger

Fade the effect. 0 means no fade and 100 means it's disabled. Note that some effects do not support fade:

  • lensblur
  • light1
  • light10
  • light11
  • light12
  • light13
  • light14
  • light15
  • light16
  • light17
  • light18
  • light19
  • light2
  • light20
  • light3
  • light4
  • light5
  • light6
  • light7
  • light8
  • light9
  • pixelize
  • saturation
  • shadow1
  • shadow2
format'JPG' | 'PNG' | 'WEBP'

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

  • JPG
  • PNG
  • WEBP

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