Background Removal with api4ai API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Background Removal with the api4ai API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
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
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Typeform uses OAuth authentication. When you connect your Typeform account, Pipedream will open a popup window where you can sign into Typeform and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Typeform API.

Pipedream requests the following authorization scopes when you connect your account:

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

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

Background Removal 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

Action 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);
  },
};

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. 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`