Search Files with ImageKit.io API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to Search Files with the ImageKit.io API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search Files with ImageKit.io API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ImageKit.io

Try it

Search Files with ImageKit.io API on New Submission from Typeform API

Typeform + ImageKit.io

Try it

Search Files with ImageKit.io API on Custom Events from Zoom API

Zoom + ImageKit.io

Try it

Search Files with ImageKit.io API on New Submission (Instant) from Jotform API

Jotform + ImageKit.io

Try it

Search Files with ImageKit.io API on New Scheduled Tasks from Pipedream API

Pipedream + ImageKit.io

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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

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

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,