Clipping Magic offers a REST-oriented Web API for automating the uploading of images and downloading of results. You can integrate the Clipping Magic Editor into your website with
ClippingMagic.js to let your users remove backgrounds right on your website.
The API is especially useful for websites needing to remove backgrounds from user-provided images, and for eCommerce websites with a staff of graphic designers removing image backgrounds on a flow of images.
To use the API you will need an API Key and some web programming skills.
The typical scenario is that an end-user uploads an image to your site, and you want to enable the user to remove the background from that image as part of your site image workflow. The steps you would normally take are:
Your user uploads an image to your website.
Your backend server passes the image to ClippingMagic.com via the backend API and gets an image id and secret back.
Your web client cannot upload the image directly to ClippingMagic.com for security reasons.
Your backend server passes the image id and secret to your web client. If you're using AJAX this information can be included in the response to the image upload. Otherwise it can be embedded in the webpage you render in response to the user's image upload.
On your site, let the end-user remove the background with
Upon receiving the
result-generated callback from
Your backend server downloads the result and continues with the subsequent steps in your site-specific workflow.
The typical scenario is that you have a long list of images that need to be processed, and some staff to process them. The steps you would normally take are:
Upload a batch of images one at a time to ClippingMagic.com via the backend API. Get and store the respective image ids and secrets.
In your internal system, allocate images to workers in suitable batches. Then let each worker remove the backgrounds from a batch with
ClippingMagic.js, using the Edit Multiple Images In Sequence workflow with the corresponding image ids and secrets from step 1.
Typical batch sizes vary between 10 and 100 depending on volume and the particulars of your images.
Upon receiving the
result-generated callbacks from
ClippingMagic.js notify your backend to download the result for that image.
Rinse and repeat.
Note that all upload and download operations happen on the backend, but all clipping operations happen in the web client (frontend) using
This split safeguards your API Key, while enabling a seamless end-user experience on your site.
Is something missing or insufficiently documented? Does your implementation require additional features?
Be sure to let us know and we'll try to sort it out!