Create Integration with Nango API on New Batch Completed from OpenAI (ChatGPT) API

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

Trigger workflow on

New Batch Completed from the OpenAI (ChatGPT) API

Next, do this

Create Integration with the Nango 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 Nango 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 Create Integration action
1. Connect your Nango account
2. Configure Client ID
3. Configure Client Secret
4. Select a Provider
5. Configure Integration Unique Key
6. Optional- Configure OAuth Scopes
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#

Create Integration on Nango

Description:Create a new Integration. [See the Documentation](https://docs.nango.dev/api-reference/integration/create)

Version:0.0.1

Key:nango-create-integration

View on GitHub

Nango Overview#

The Nango API is a bridge for integrating with SaaS apps, smoothing out authentication and API call complexities. On Pipedream, you can harness Nango to automate interactions between various services without getting bogged down by the nuances of OAuth flows or API intricacies. Use Nango to authenticate once, and let Pipedream workflows handle the rest, executing tasks, syncing data, and triggering actions across apps efficiently.

Action Code#

import app from "../../nango.app.mjs";
import providers from "../../common/providers.mjs";

export default {
  key: "nango-create-integration",
  name: "Create Integration",
  description: "Create a new Integration. [See the Documentation](https://docs.nango.dev/api-reference/integration/create)",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    oauthClientId: {
      type: "string",
      label: "Client ID",
      description: "Obtain the Client ID on the developer portal of the Integration Provider.",
    },
    oauthClientSecret: {
      type: "string",
      label: "Client Secret",
      description: "Obtain the Client Secret on the developer portal of the Integration Provider.",
      secret: true,
    },
    provider: {
      type: "string",
      label: "Provider",
      description: "The Provider of the Integration.",
      options() {
        return providers.getProviders();
      },
    },
    providerConfigKey: {
      type: "string",
      label: "Integration Unique Key",
      description: "Choose a unique key for your integration. It can be the same as the Integration Provider (e.g. github, airtable).",
    },
    oauthScopes: {
      optional: true,
      propDefinition: [
        app,
        "oauthScopes",
      ],
    },
  },
  methods: {
    scopesToStr(scopes = "") {
      if (Array.isArray(scopes)) {
        return scopes.join(",");
      }
      return scopes;
    },
    createIntegration(args = {}) {
      return this.app.post({
        path: "/config",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      oauthClientId,
      oauthClientSecret,
      provider,
      providerConfigKey,
      oauthScopes,
    } = this;

    await this.createIntegration({
      step,
      data: {
        oauth_client_id: oauthClientId,
        oauth_client_secret: oauthClientSecret,
        provider,
        provider_config_key: providerConfigKey,
        oauth_scopes: this.scopesToStr(oauthScopes),
      },
    });

    step.export("$summary", "Successfully created Integration.");

    return {
      success: true,
      provider,
      providerConfigKey,
    };
  },
};

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
Nango	`app`	`app`	This component uses the Nango app.
Client ID	`oauthClientId`	`string`	Obtain the Client ID on the developer portal of the Integration Provider.
Client Secret	`oauthClientSecret`	`string`	Obtain the Client Secret on the developer portal of the Integration Provider.
Provider	`provider`	`string`	Select a value from the drop down menu.
Integration Unique Key	`providerConfigKey`	`string`	Choose a unique key for your integration. It can be the same as the Integration Provider (e.g. github, airtable).
OAuth Scopes	`oauthScopes`	`string[]`	The OAuth Scopes of the Integration. The list of scope should be found in the documentation of the external provider.