Search Files with ImageKit.io API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Search Files with the ImageKit.io 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 ImageKit.io 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 Search Files action
1. Connect your ImageKit.io account
2. Select a Type
3. Optional- Select a Sort
4. Optional- Configure Path
5. Optional- Configure Search Query
6. Optional- Select a File 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#

Search Files on ImageKit.io

Description:List all the uploaded files and folders in your ImageKit.io media library. [See the documentation](https://docs.imagekit.io/api-reference/media-api/list-and-search-files#list-and-search-file-api)

Version:0.0.2

Key:imagekit_io-search-files

View on GitHub

ImageKit.io Overview#

ImageKit.io API lets you manage, optimize, and deliver images dynamically for your web applications. On Pipedream, you can integrate this API to construct serverless workflows that automate your image operations and connect with other services. You can upload images from various sources, apply real-time transformations, and track media assets without managing infrastructure.

Action Code#

import { FILE_SORT } from "../../common/constants.mjs";
import imagekitIo from "../../imagekit_io.app.mjs";

export default {
  key: "imagekit_io-search-files",
  name: "Search Files",
  version: "0.0.2",
  description: "List all the uploaded files and folders in your ImageKit.io media library. [See the documentation](https://docs.imagekit.io/api-reference/media-api/list-and-search-files#list-and-search-file-api)",
  type: "action",
  props: {
    imagekitIo,
    type: {
      type: "string",
      label: "Type",
      description: "Limit search to one of **file**, **file-version**, or **folder**. Pass **all** to include files and folders in search results (**file-version** will not be included in this case).",
      options: [
        "file",
        "file-version",
        "folder",
        "all",
      ],
      default: "file",
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "The sort of the response.",
      options: FILE_SORT,
      optional: true,
    },
    path: {
      type: "string",
      label: "Path",
      description: "Folder path if you want to limit the search within a specific folder.",
      optional: true,
    },
    searchQuery: {
      type: "string",
      label: "Search Query",
      description: "Query string in a Lucene-like query language. `Note`: When the **searchQuery** parameter is present, the following query parameters will have no effect on the result: **tags**, **type**, **name**.",
      optional: true,
    },
    fileType: {
      type: "string",
      label: "File Type",
      description: "Type of files to include in the result set.",
      options: [
        "all",
        "image",
        "non-image",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      imagekitIo,
      ...data
    } = this;

    const items = imagekitIo.paginate({
      fn: imagekitIo.searchFiles,
      headers: {
        "content-type": "application/x-www-form-urlencoded",
      },
      params: data,
    });

    const responseArray = [];
    for await (const item of items) {
      responseArray.push(item);
    }

    $.export("$summary", `${responseArray.length} file${responseArray.length > 1
      ? "s were"
      : " was"} successfully fetched!`);
    return responseArray;
  },
};

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
ImageKit.io	`imagekitIo`	`app`	This component uses the ImageKit.io app.
Type	`type`	`string`	Select a value from the drop down menu:`filefile-versionfolderall`
Sort	`sort`	`string`	Select a value from the drop down menu:`ASC_NAMEDESC_NAMEASC_CRATEDDESC_CRATEDASC_UPDATEDDESC_UPDATEDASC_HEIGHTDESC_HEIGHTASC_WIDTHDESC_WIDTHASC_SIZEDESC_SIZE`
Path	`path`	`string`	Folder path if you want to limit the search within a specific folder.
Search Query	`searchQuery`	`string`	Query string in a Lucene-like query language. `Note`: When the searchQuery parameter is present, the following query parameters will have no effect on the result: tags, type, name.
File Type	`fileType`	`string`	Select a value from the drop down menu:`allimagenon-image`

Action Authentication#

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

To retrieve your Private Key,