Process Batch of Images with Imagga API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Imagga, Schedule and 2,200+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Process Batch of Images with the Imagga 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 Schedule trigger and Imagga action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Process Batch of Images action
1. Connect your Imagga account
2. Optional- Configure Image URLs
3. Optional- Configure Image File Paths
4. Optional- Configure Callback URL
5. Select a Image Process Type
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Process Batch of Images on Imagga

Description:Analyzes a batch of images for categorization, tagging, or color extraction. [See the documentation](https://docs.imagga.com/)

Version:0.0.1

Key:imagga-process-batch

View on GitHub

Imagga Overview#

The Imagga API is a powerful image recognition tool that enables you to automate the process of analyzing and tagging images. With its AI-driven capabilities, you can extract a wealth of information from visual content. It offers features such as categorization, color extraction, and auto-tagging, making it incredibly useful for building workflows that require image analysis.

Action Code#

import { prepareAdditionalProps } from "../../common/constants.mjs";
import {
  delay,
  prepareBatchFile,
} from "../../common/utils.mjs";
import imagga from "../../imagga.app.mjs";

export default {
  key: "imagga-process-batch",
  name: "Process Batch of Images",
  description: "Analyzes a batch of images for categorization, tagging, or color extraction. [See the documentation](https://docs.imagga.com/)",
  version: "0.0.1",
  type: "action",
  props: {
    imagga,
    imageUrl: {
      label: "Image URLs",
      description: "The array of Image URLs to analyze.",
      type: "string[]",
      optional: true,
    },
    imageFile: {
      label: "Image File Paths",
      description:
        "The array of Image file path from [`/tmp` dir](https://pipedream.com/docs/code/nodejs/working-with-files/#the-tmp-directory) to analyze.",
      type: "string[]",
      optional: true,
    },
    callbackUrl: {
      propDefinition: [
        imagga,
        "callbackUrl",
      ],
      optional: true,
    },
    imageProcessType: {
      propDefinition: [
        imagga,
        "imageProcessType",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    return prepareAdditionalProps({
      props: imagga.propDefinitions,
      type: this.imageProcessType,
      batch: true,
    });
  },
  async run({ $ }) {
    const {
      imagga,
      imageUrl,
      imageFile,
      language = [],
      saveIndex,
      saveId,
      extractOverallColors,
      extractObjectColors,
      deterministic,
      verbose,
      threshold,
      decreaseParents,
      callbackUrl,
      categorizerId,
      overallCount,
      separatedCount,
      imageProcessType,
      ...params
    } = this;

    const file = await prepareBatchFile({
      imageUrl,
      imageFile,
      imagga,
    });

    await delay(2000);

    const response = await this.imagga.analyzeBatch({
      data: {
        callback_url: callbackUrl,
        [`/${imageProcessType}`]: file.map((item) => {
          if (typeof verbose === "boolean") item.params.verbose = +verbose;
          if (typeof decreaseParents === "boolean") item.params["decrease_parents"] = +decreaseParents;
          if (threshold) item.params.threshold = parseFloat(threshold);
          if (typeof extractOverallColors === "boolean") item.params.extract_overall_colors = +extractOverallColors;
          if (typeof extractObjectColors === "boolean") item.params.extract_object_colors = +extractObjectColors;
          if (typeof deterministic === "boolean") item.params.deterministic = +deterministic;

          item.params = {
            ...params,
            ...item.params,
            categorizer_id: categorizerId,
            language: language.toString(),
            overall_count: overallCount,
            separated_count: separatedCount,
            save_index: saveIndex,
            save_id: saveId,
          };
          return item;
        }),
      },
    });
    $.export("$summary", `Successfully submitted batch for ${imageProcessType} analysis`);
    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
Imagga	`imagga`	`app`	This component uses the Imagga app.
Image URLs	`imageUrl`	`string[]`	The array of Image URLs to analyze.
Image File Paths	`imageFile`	`string[]`	The array of Image file path from `/tmp` dir to analyze.
Callback URL	`callbackUrl`	`string`	The callback URL to be invoked after batch processing
Image Process Type	`imageProcessType`	`string`	Select a value from the drop down menu:`{ "label": "Tags", "value": "tags" }{ "label": "Categories", "value": "categories" }{ "label": "Colors", "value": "colors" }`