ClippingMagic

ClippingMagic is an external cloud based API for removed background on images and embedding clipping paths. The integration with ClippingMagic follows the Custom automations steps architecture. It is deployed with the Dock installation and must be further configured in an automation. The automation step is called Remove background with Clipping magic and it can be used once the integration is deployed.

The Automation it-self behaves a little different depending on the configuration, however, the end result is that the asset being sent to ClippingMagic will have its background removed and the asset is replaced.

Configuring the automation is done in two places

  • General configuration

  • Automation step

The general configuration is available under Administration → Integrations → Integrations configurations

image-20240920-103244.png

This allows editing the following two parameters

Parameter

Description

Parameter

Description

ApiKey

The API Key for ClippingMagic

FallbackFormatId

Clipping magic supports only up to a certain size and if the input image is too big, this defines the fallback media format to be used instead.

The Automation step it self has the following options

Parameter

Description

Parameter

Description

AssetId

The assetid to replace

ComputerName

ComputerName is a name defining where the upload/replace is coming from. This is used in other automations to determine if actions should be executed.

RunInTestMode

This allows ClippingMagic to be requested in test mode and thereby without an API Key. The caveat is that the result has a watermark and the uploaded image is kept in ClippingMagic and cannot be deleted.

BackgroundColor

The hex value for the background color

Format

Defines the resulting output. For a full list see the same input parameter in the API Docs from ClippingMagic.