Using the API Playground

Test BackgroundErase API options directly in the browser by uploading an image, adjusting flags, and running requests.

Maxwell
Written by Maxwell
Updated in March 2026

The API Playground lets you try BackgroundErase API behavior without writing code. You can upload an image, choose the flags you want to test, run the request, and inspect or download the result directly in the browser.

Quick summary: Upload an image, choose your flags, click Run request, and download the result. You can reuse the same image for multiple tests or clear it and start again.


What the Playground is for

The Playground is useful when you want to experiment with API options like format, size, crop, bg_color, or despill and immediately see how the output changes.

It’s especially helpful for testing combinations before you implement the same settings in your app or backend.

Step-by-step

  1. Open the API Playground.
  2. In the input section, click Upload image and choose your file.
  3. Select the flags you want to use.
  4. Click Run request.
  5. Review the output image and compare the result.
  6. Download the image if you want to save it.

Reusing the same image

You do not need to upload a new image every time you want to test a different setting. You can keep the same image loaded, change the flags, and press Run request again.

This makes it easy to compare how different options affect the same source image.

Clearing the input image

If you want to start over with a different image, click Clear in the top-right corner of the input section. This removes the current image so you can upload another one.

Downloading results

After running a request, you can download the resulting image directly from the Playground. This is useful if you want to save comparison outputs while testing different flags.

  • Run a request
  • Inspect the output
  • Download the result you want to keep

Common testing workflow

A common way to use the Playground is:

  1. Upload one image.
  2. Run a baseline request with default settings.
  3. Change one flag (for example, turn on crop or despill).
  4. Run the request again.
  5. Compare the new result.
  6. Repeat until you find the settings you want to use in production.

Tip: Change one flag at a time when testing. That makes it much easier to see which option is actually affecting the output.

Screenshot reference

API Playground showing uploaded  input, flags, run request button, clear button, and output preview
(Screenshot: API Playground workflow)