Car Image Background Removal with api4ai API on New Finished Actor Run (Instant) from Apify API

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

Trigger workflow on

New Finished Actor Run (Instant) from the Apify API

Next, do this

Car Image Background Removal with the api4ai API

No credit card required

▶

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#

This integration creates a workflow with a Apify trigger and api4ai action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Finished Actor Run (Instant) trigger
1. Connect your Apify account
2. Select a Actor ID
Configure the Car Image 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
6. Optional- Configure Draw a shadow
7. Optional- Configure Hide car license plates
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Finished Actor Run (Instant) on Apify

Description:Emit new event when a selected Actor is run and finishes.

Version:0.0.4

Key:apify-new-finished-actor-run-instant

View on GitHub

Apify Overview#

The Apify API unleashes the power to automate web scraping, process data, and orchestrate web automation workflows. By utilizing Apify on Pipedream, you can create dynamic serverless workflows to manage tasks like extracting data from websites, running browser automation, and scheduling these jobs to run autonomously. It integrates smoothly with Pipedream's capabilities to trigger actions on various other apps, store the results, and manage complex data flow with minimal setup.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "apify-new-finished-actor-run-instant",
  name: "New Finished Actor Run (Instant)",
  description: "Emit new event when a selected Actor is run and finishes.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    actorId: {
      propDefinition: [
        common.props.apify,
        "userActorId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getCondition() {
      return {
        actorId: this.actorId,
      };
    },
    getSummary(body) {
      return `A new Actor run ${body.eventData.actorRunId} has finished`;
    },
  },
  sampleEmit,
};

Trigger 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
Apify	`apify`	`app`	This component uses the Apify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Actor ID	`actorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Apify uses API keys for authentication. When you connect your Apify account, Pipedream securely stores the keys so you can easily authenticate to Apify APIs in both code and no-code steps.

About Apify#

Apify is the place to find, develop, buy and run cloud programs called actors. Use actors to turn any website into an API.

Action#

Car Image Background Removal on api4ai

Description:Remove Background for car images. Powered by API4AI.

Version:0.0.2

Key:api4ai-car-image-background-removal

View on GitHub

Car Image Background Removal Overview#

⭐️ Cars Image Background Removal designed to enhance automotive imagery, featuring high-accuracy segmentation, background removal, shadow effects, license plate blurring, and custom background replacement.

car-bg-removal

🤖 Demo

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

Action Code#

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

export default {
  name: "Car Image Background Removal",
  description:
    "Remove Background for car images. Powered by API4AI.",
  key: "api4ai-car-image-background-removal",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Subscribe to [API4AI Cars Image Background Removal](https://rapidapi.com/api4ai-api4ai-default/api/cars-image-background-removal/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",
      ],
    },
    shadow: {
      type: "boolean",
      label: "Draw a shadow",
      description: "Draw a shadow underneath the car.",
      default: true,
      optional: true,
    },
    hideclp: {
      type: "boolean",
      label: "Hide car license plates",
      description: "Hide car license plates.",
      default: false,
      optional: true,
    },
  },
  async run({ $ }) {
    // Initialize output.
    let summary = "";
    let result = "";
    const objects = [];
    let width = 0;
    let height = 0;

    // Prepare query params.
    let mode = "fg-mask";
    if (!this.mask) {
      mode = "fg-image";
      if (this.shadow) {
        mode += "-shadow";
      }
      if (this.hideclp) {
        mode += "-hideclp";
      }
    }
    const representation = this.representation == "URL to file"
      ? "url"
      : "base64";

    // Perform request and parse results.
    const cb = () =>
      this.app.makeRequest(
        $,
        "https://cars-image-background-removal.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);
  },
};

Action Configuration#

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

Label	Prop	Type	Description
api4ai	`app`	`app`	This component uses the api4ai app.
Image	`image`	`string`	Input image. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).
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`
Draw a shadow	`shadow`	`boolean`	Draw a shadow underneath the car.
Hide car license plates	`hideclp`	`boolean`	Hide car license plates.

Action Authentication#

api4ai uses API keys for authentication. When you connect your api4ai account, Pipedream securely stores the keys so you can easily authenticate to api4ai APIs in both code and no-code steps.