Background Removal with api4ai API

Pipedream makes it easy to connect APIs for api4ai and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Background Removal with the api4ai API

No credit card required

Overview#

⭐️ Background Removal offers advanced image analysis for foreground segmentation and effortless background removal.

bg-removal

🤖 Demo

Discover the Background Removal Web demo for free and get a feel for its capabilities before diving deeper. No registration is required: https://api4.ai/apis/bg-removal#demo-wrapper

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Background Removal with the api4ai API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Background Removal action
1. Connect your api4ai account
2. Configure alert
3. Configure Image
4. Optional- Configure Mask mode
5. Optional- Select a Result image representation
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Background Removal with api4ai API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + api4ai

Try it

Background Removal with api4ai API on New Submission from Typeform API

Typeform + api4ai

Try it

Background Removal with api4ai API on New Submission (Instant) from Jotform API

Jotform + api4ai

Try it

Background Removal with api4ai API on New Scheduled Tasks from Pipedream API

Pipedream + api4ai

Try it

Background Removal with api4ai API on npm Download Counts from npm API

npm + api4ai

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Background Removal on api4ai

Description:Automatically and quickly remove image background with high accuracy. Powered by API4AI.

Version:0.0.1

Key:api4ai-background-removal

View on GitHub

Code#

import app from "../../api4ai.app.mjs";
import {
  retryWithExponentialBackoff, representFile,
} from "../../common/utils.mjs";

export default {
  name: "Background Removal",
  description:
    "Automatically and quickly remove image background with high accuracy. Powered by API4AI.",
  key: "api4ai-background-removal",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Subscribe to [API4AI Background Removal](https://rapidapi.com/api4ai-api4ai-default/api/background-removal4/pricing) on the RapidAPI hub before you start using it.",
    },
    image: {
      propDefinition: [
        app,
        "image",
      ],
    },
    mask: {
      type: "boolean",
      label: "Mask mode",
      description:
        "Return the foreground object mask instead of the image with the background removed.",
      default: false,
      optional: true,
    },
    representation: {
      type: "string",
      label: "Result image representation",
      description:
        "Return the result image as:\n  * **path** to a file (default)\n  * **URL** to a file hosted by api4ai (valid for 1 day)\n  * **Base64** string with file's content\n  * **Buffer** encoded in JSON with a file's content\n  * **Array** of bytes with a file's content",
      default: "Path to file",
      optional: true,
      options: [
        "Path to file",
        "URL to file",
        "Base64 string",
        "JSON Buffer",
        "Array",
      ],
    },
  },
  async run({ $ }) {
    // Initialize output.
    let summary = "";
    let result = "";
    const objects = [];
    let width = 0;
    let height = 0;

    // Prepare query params.
    const mode = this.mask
      ? "fg-mask"
      : "fg-image";
    const representation = this.representation == "URL to file"
      ? "url"
      : "base64";

    // Perform request and parse results.
    const cb = () =>
      this.app.makeRequest(
        $,
        "https://background-removal4.p.rapidapi.com/v1/results",
        this.image,
        {
          mode,
          representation,
        },
      );
    const response = await retryWithExponentialBackoff(cb);
    const isOk = response?.results?.[0]?.status?.code === "ok";
    summary = response?.results?.[0]?.status?.message || JSON.stringify(response);
    if (isOk) {
      result = response.results[0].entities[0].image;
      const rawObjects = response.results[0].entities[1].objects;
      rawObjects.forEach(function (o) {
        const box = {
          x: o.box[0],
          y: o.box[1],
          w: o.box[2],
          h: o.box[3],
        };
        const cls = Object.keys(o.entities[0].classes)[0];
        objects.push({
          class: cls,
          box: box,
        });
      });
      const format = response.results[0].entities[0].format;
      result = representFile(result, format, this.representation);
      width = response.results[0].width;
      height = response.results[0].height;
    }
    else {
      throw new Error(summary);
    }

    $.export("$summary", summary);
    $.export("result", result);
    $.export("objects", objects);
    $.export("width", width);
    $.export("height", height);
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
api4ai	`app`	`app`	This component uses the api4ai app.
Image	`image`	`string`	Input image. Various types are accepted: a path to a file a URL to a file a file's content encoded as a base64 string a file's content as a Buffer encoded in JSON a file's content as an Array of bytes
Mask mode	`mask`	`boolean`	Return the foreground object mask instead of the image with the background removed.
Result image representation	`representation`	`string`	Select a value from the drop down menu:`Path to fileURL to fileBase64 stringJSON BufferArray`

Try it

Brand Recognition with the api4ai API

The service processes input image and responds with a list of found brand logos. Powered by API4AI.

Try it

Car Image Background Removal with the api4ai API

Remove Background for car images. Powered by API4AI.

Try it

Furniture & Household Item Recognition with the api4ai API

This API provides identification of furniture & household items with advanced intelligent detection, categorization, and counting technologies. Powered by API4AI.

Try it

Image Anonymization with the api4ai API

Performs actual image anonymization. Powered by API4AI.

Try it