Remove Background with Claid AI API on New Scheduled Tasks from AWS API

Pipedream makes it easy to connect APIs for Claid AI, AWS and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the AWS API

Next, do this

Remove Background with the Claid AI 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 AWS trigger and Claid AI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Configure Secret
Configure the Remove Background action
1. Connect your Claid AI account
2. Configure File Path or URL
3. Optional- Select a Category
4. Configure Remove Background
5. Optional- Configure syncDir
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 Scheduled Tasks on AWS

Description:Creates a Step Function State Machine to publish a message to an SNS topic at a specific timestamp. The SNS topic delivers the message to this Pipedream source, and the source emits it as a new event.

Version:0.4.3

Key:aws-new-scheduled-tasks

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/scheduled.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...base,
  key: "aws-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  description: toSingleLineString(`
    Creates a Step Function State Machine to publish a message
    to an SNS topic at a specific timestamp. The SNS topic delivers
    the message to this Pipedream source, and the source emits it as a new event.
  `),
  version: "0.4.3",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  methods: {
    ...base.methods,
    getStateMachineDefinition() {
      const { PD_COMPONENT: componentId } = process.env;
      const topicArn = this.getTopicArn();
      return {
        Comment: `Task Scheduler for Pipedream component ${componentId}`,
        StartAt: "Wait",
        States: {
          Wait: {
            Comment: "Wait until specified timestamp",
            Type: "Wait",
            TimestampPath: "$.timestamp",
            Next: "SendMessageToSNS",
          },
          SendMessageToSNS: {
            Type: "Task",
            Resource: "arn:aws:states:::sns:publish",
            Parameters: {
              "TopicArn": topicArn,
              "Message.$": "$",
            },
            End: true,
          },
        },
      };
    },
    getStateMachinePermissions() {
      const topicArn = this.getTopicArn();
      const document = {
        Version: "2012-10-17",
        Statement: [
          {
            Effect: "Allow",
            Action: [
              "sns:Publish",
            ],
            Resource: [
              topicArn,
            ],
          },
        ],
      };
      const name = "publish-messages-to-pipedream-sns-topic";
      return {
        document,
        name,
      };
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS 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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `secret` parameter of each HTTP POST request

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Remove Background on Claid AI

Description:Easily erases the image's background, effectively isolating the main subject. [See the documentation](https://docs.claid.ai/image-editing-api/image-operations/background)

Version:0.1.2

Key:claid_ai-remove-background

View on GitHub

Claid AI Overview#

Claid AI API provides tools for image enhancement, including resizing, cropping, increasing resolution, and optimizing for web use. It's suitable for automating image processing tasks in applications like e-commerce, real estate, and content management. On Pipedream, you can create serverless workflows that use the Claid AI API to process images in response to various triggers, such as new file uploads or webhooks, and then pass the processed images to other services or store them.

Action Code#

import FormData from "form-data";
import urlExists from "url-exist";
import claidAi from "../../claid_ai.app.mjs";
import { getFileStreamAndMetadata } from "@pipedream/platform";

export default {
  key: "claid_ai-remove-background",
  name: "Remove Background",
  description: "Easily erases the image's background, effectively isolating the main subject. [See the documentation](https://docs.claid.ai/image-editing-api/image-operations/background)",
  version: "0.1.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    claidAi,
    image: {
      propDefinition: [
        claidAi,
        "image",
      ],
    },
    category: {
      type: "string",
      label: "Category",
      description: "Provides a hint about the nature of object in the foreground for a more accurate result of background removal.",
      options: [
        "general",
        "products",
        "cars",
      ],
      reloadProps: true,
      optional: true,
    },
    removeBackground: {
      type: "boolean",
      label: "Remove Background",
      description: "Removes image background.",
      default: true,
      reloadProps: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.removeBackground) {
      props.clipping = {
        type: "boolean",
        label: "Clipping",
        description: "If **true**, image is clipped to the foreground object bounds.",
        default: false,
      };
      props.color = {
        type: "string",
        label: "Background Color",
        description: "The image background. You can set **transparent** or any color in hexadecimal format.",
        default: "transparent",
      };
    } else {
      props.type = {
        type: "string",
        label: "Blur Type",
        description: "Type of blur to be applied to the background.",
        options: [
          "regular",
          "lens",
        ],
      };
      props.level = {
        type: "string",
        label: "Level",
        description: "The level of blur strength to be applied to the background.",
        options: [
          "low",
          "medium",
          "high",
        ],
      };
    }
    return props;
  },
  async run({ $ }) {
    let imageUrl = this.image;
    let response = "";

    const operations = {
      background: this.removeBackground
        ? {
          remove: {
            category: this.category,
            clipping: this.clipping,
          },
          color: this.color,
        }
        : {
          blur: {
            category: this.category,
            clipping: this.clipping,
          },
        },
    };

    if (!await urlExists(this.image)) {
      const {
        stream, metadata,
      } = await getFileStreamAndMetadata(this.image);
      const formData = new FormData();
      formData.append("file", stream, {
        contentType: metadata.contentType,
        knownLength: metadata.size,
        filename: metadata.name,
      });
      formData.append("data", JSON.stringify({
        operations,
      }));

      response = await this.claidAi.uploadImage({
        $,
        data: formData,
        headers: formData.getHeaders(),
      });
    } else {
      response = await this.claidAi.editImage({
        $,
        data: {
          input: imageUrl,
          operations,
          output: {
            format: "png",
          },
        },
      });
    }

    $.export("$summary", "Successfully removed the background from the image");
    return response;
  },
};

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
Claid AI	`claidAi`	`app`	This component uses the Claid AI app.
File Path or URL	`image`	`string`	The image to process. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myImage.jpg`)
Category	`category`	`string`	Select a value from the drop down menu:`generalproductscars`
Remove Background	`removeBackground`	`boolean`	Removes image background.
syncDir	`syncDir`	`dir`

Action Authentication#

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

About Claid AI#

Transform e-commerce visuals effortlessly with Claid AI. From image enhancements to AI Photoshoots, create professional product photos that drive conversion 📸✨

More Ways to Connect Claid AI + AWS#

Other Popular Integrations#

Remove Background with Claid AI API on New DynamoDB Stream Event from AWS API

AWS + Claid AI

Remove Background with Claid AI API on New Scheduled Tasks from AWS API

Pipedream makes it easy to connect APIs for Claid AI, AWS and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular