Object Detection with JigsawStack API on New Created Company from Roll API

Pipedream makes it easy to connect APIs for JigsawStack, Roll and 2,700+ other apps remarkably fast.

Trigger workflow on

New Created Company from the Roll API

Next, do this

Object Detection with the JigsawStack 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 Roll trigger and JigsawStack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Created Company trigger
1. Connect your Roll account
2. Configure Polling interval
Configure the Object Detection action
1. Connect your JigsawStack account
2. Optional- Configure Image File or URL
3. Optional- Configure File Store Key
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 Created Company on Roll

Description:Emit new event when a company is created.

Version:0.0.1

Key:roll-new-created-company

View on GitHub

Roll Overview#

The Roll API serves as a bridge to Roll's project management software, enabling users to automate tasks, manipulate project data, and integrate with countless other apps within the Pipedream ecosystem. By leveraging this API, you can streamline operations, sync data across various platforms, and create custom notifications that power up your project management workflows.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Created Company",
  key: "roll-new-created-company",
  description: "Emit new event when a company is created.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getFieldId() {
      return "CompanyId";
    },
    getFieldResponse() {
      return "company";
    },
    getQuery() {
      return "listCompanies";
    },
    getOrderField() {
      return "-CompanyId";
    },
    getDataToEmit({ CompanyId }) {
      return {
        id: CompanyId,
        summary: `New company with CompanyId ${CompanyId} was successfully created!`,
        ts: new Date().getTime(),
      };
    },
  },
};

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
Roll	`roll`	`app`	This component uses the Roll app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Roll API on this schedule

Trigger Authentication#

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

You can get your access token from your user profile page in Roll. Click a username, and in the slider that appears on the right, look for the API access token section.

About Roll#

Roll is a platform with everything your business needs in one place. Manage projects, track sales, understand and grow your business.

Action#

Object Detection on JigsawStack

Description:Recognize objects within a provided image and retrieve it with great accuracy. [See the documentation](https://docs.jigsawstack.com/api-reference/ai/object-detection)

Version:1.0.1

Key:jigsawstack-object-detection

View on GitHub

Action Code#

import {
  ConfigurationError,
  getFileStreamAndMetadata,
} from "@pipedream/platform";
import mime from "mime";
import { throwError } from "../../common/utils.mjs";
import jigsawstack from "../../jigsawstack.app.mjs";

export default {
  key: "jigsawstack-object-detection",
  name: "Object Detection",
  description: "Recognize objects within a provided image and retrieve it with great accuracy. [See the documentation](https://docs.jigsawstack.com/api-reference/ai/object-detection)",
  version: "1.0.1",
  type: "action",
  props: {
    jigsawstack,
    file: {
      type: "string",
      label: "Image File or URL",
      description: "The URL or file path of the image to process.",
      optional: true,
    },
    fileStoreKey: {
      type: "string",
      label: "File Store Key",
      description: "The key used to store the image on Jigsawstack file [Storage](https://docs.jigsawstack.com/api-reference/store/file/add).",
      optional: true,
    },
  },
  methods: {
    streamToBuffer(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];
        stream.on("data", (chunk) => chunks.push(chunk));
        stream.on("end", () => resolve(Buffer.concat(chunks)));
        stream.on("error", reject);
      });
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      jigsawstack,
      file,
      fileStoreKey,
    } = this;

    const data = {};

    if (file && fileStoreKey) {
      throw new ConfigurationError("You must provide only one option, either the **Image File or URL** or the **File Storage Key**.");
    }
    if (!file && !fileStoreKey) {
      throw new ConfigurationError("You must provide either the **Image File or URL** or the **File Storage Key**.");
    }

    if (fileStoreKey) data.file_store_key = fileStoreKey;

    if (file) {
      if (file.startsWith("http")) {
        data.url = file;
      } else {
        const {
          stream, metadata,
        } = await getFileStreamAndMetadata(file);
        const buffer = await this.streamToBuffer(stream);
        const { key } = await jigsawstack.uploadFile({
          headers: {
            "Content-Type": metadata.contentType ?? mime.getType(metadata.name),
          },
          data: buffer,
        });
        data.file_store_key = key;
      }
    }

    try {
      const response = await jigsawstack.detectObjectsInImage({
        $,
        data,
      });
      $.export("$summary", "Successfully detected objects in the image");
      return response;

    } catch (e) {
      return throwError(e);
    }
  },
};

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
JigsawStack	`jigsawstack`	`app`	This component uses the JigsawStack app.
Image File or URL	`file`	`string`	The URL or file path of the image to process.
File Store Key	`fileStoreKey`	`string`	The key used to store the image on Jigsawstack file Storage