Add Data Store Record with NiftyImages API on New Batch Completed from OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for NiftyImages, OpenAI (ChatGPT) and 2,400+ other apps remarkably fast.

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Add Data Store Record with the NiftyImages 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 OpenAI (ChatGPT) trigger and NiftyImages action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Batch Completed trigger
1. Connect your OpenAI (ChatGPT) account
2. Configure timer
Configure the Add Data Store Record action
1. Connect your NiftyImages account
2. Configure Data Store API 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 Batch Completed on OpenAI (ChatGPT)

Description:Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)

Version:0.0.5

Key:openai-new-batch-completed

View on GitHub

OpenAI (ChatGPT) Overview#

OpenAI provides a suite of powerful AI models through its API, enabling developers to integrate advanced natural language processing and generative capabilities into their applications. Here’s an overview of the services offered by OpenAI's API:

Use Python or Node.js code to make fully authenticated API requests with your OpenAI account:

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "openai-new-batch-completed",
  name: "New Batch Completed",
  description: "Emit new event when a new batch is completed in OpenAI. [See the documentation](https://platform.openai.com/docs/api-reference/batch/list)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    _getLastCompleted() {
      return this.db.get("lastCompleted") || 0;
    },
    _setLastCompleted(lastCompleted) {
      this.db.set("lastCompleted", lastCompleted);
    },
    getMeta(batch) {
      return {
        id: batch.id,
        summary: `Batch Completed with ID ${batch.id}`,
        ts: batch.completed_at * 1000,
      };
    },
    async getAndProcessItems(max) {
      const lastCompleted = this._getLastCompleted();
      let maxCompleted = lastCompleted;
      const results = this.openai.paginate({
        resourceFn: this.openai.listBatches,
        max,
      });
      const batches = [];
      for await (const batch of results) {
        if (batch.completed_at && batch.completed_at > lastCompleted) {
          batches.push(batch);
          maxCompleted = Math.max(batch.completed_at, maxCompleted);
        }
      }
      this._setLastCompleted(maxCompleted);
      batches.reverse().forEach((item) => this.$emit(item, this.getMeta(item)));
    },
  },
  sampleEmit,
};

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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About OpenAI (ChatGPT)#

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Action#

Add Data Store Record on NiftyImages

Description:Create or update a Data Store Record [See docs here](https://api.niftyimages.com/)

Version:0.0.1

Key:niftyimages-add-data-store-record

View on GitHub

NiftyImages Overview#

The NiftyImages API allows for the dynamic creation and customization of images for email marketing campaigns. By automating image personalization, users can create unique, engaging visuals that resonate with each recipient. It's possible to insert text into images, generate countdown timers, and manipulate image URLs on the fly, enhancing the visual appeal and relevance of marketing messages.

Action Code#

import niftyimages from "../../app/niftyimages.app.mjs";
import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
export default defineAction({
    name: "Add Data Store Record",
    description: "Create or update a Data Store Record [See docs here](https://api.niftyimages.com/)",
    key: "niftyimages-add-data-store-record",
    version: "0.0.1",
    type: "action",
    props: {
        niftyimages,
        dataStoreApiKey: {
            label: "Data Store API Key",
            description: `The API Key for the Data Store you want to create/update a record on.
        \\
        To find this, go to **Data Sources**, choose a Data Store, and click on **"Use Our API"**.
        \\
        *Note that only a **Custom Store** can be updated.*`,
            type: "string",
            reloadProps: true,
        },
    },
    async additionalProps() {
        const newProps = {};
        const apiKey = this.dataStoreApiKey?.trim();
        let fields;
        try {
            fields = await this.niftyimages.getDataStoreFields(apiKey);
        }
        catch (err) {
            throw new ConfigurationError("Error fetching data - please check the **API Key**.");
        }
        const newPropNames = [];
        fields.forEach((field) => {
            const { name, type, date_input_format, } = field;
            newProps[name] = {
                label: this.niftyimages.getFieldLabel(field),
                description: date_input_format
                    ? `Must be a date in the \`${date_input_format}\` format`
                    : undefined,
                type: this.niftyimages.getFieldPropType(type),
            };
            newPropNames.push(name);
        });
        newProps["$fieldNames"] = {
            label: "Fields to Update",
            description: "Comma-separated list of the fields to be updated (defaults to all).",
            type: "string",
            optional: true,
            default: newPropNames.join(),
        };
        return newProps;
    },
    async run({ $ }) {
        // I had to explicitly cast the type here due to a current limitation
        // in the action type combined with the additionalProps method
        const $this = this;
        const strNames = $this.$fieldNames?.trim();
        if (!strNames) {
            throw new ConfigurationError("Please check the `Fields to Update` prop.");
        }
        const data = {};
        strNames.split(",").forEach((fieldName) => {
            const name = fieldName.trim();
            data[name] = $this[name];
        });
        const params = {
            $,
            apiKey: $this.dataStoreApiKey,
            data,
        };
        const response = await $this.niftyimages.addRecord(params);
        $.export("$summary", "Updated record successfully");
        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
NiftyImages	`niftyimages`	`app`	This component uses the NiftyImages app.
Data Store API Key	`dataStoreApiKey`	`string`	The API Key for the Data Store you want to create/update a record on. To find this, go to Data Sources, choose a Data Store, and click on "Use Our API". Note that only a Custom Store* can be updated.*

Action Authentication#

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

To retrieve your API key,