Create Image (Dall-E) with OpenAI (ChatGPT) API on New Child Object in a Realtime Database from Firebase Admin SDK API

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

Trigger workflow on

New Child Object in a Realtime Database from the Firebase Admin SDK API

Next, do this

Create Image (Dall-E) with the OpenAI (ChatGPT) 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 Firebase Admin SDK trigger and OpenAI (ChatGPT) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Child Object in a Realtime Database trigger
1. Connect your Firebase Admin SDK account
2. Configure Polling Interval
3. Optional- Select a Database Region
4. Configure Path
Configure the Create Image (Dall-E) action
1. Connect your OpenAI (ChatGPT) account
2. Select a Model
3. Configure Prompt
4. Optional- Select a Response Format
5. Optional- Select a Size
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 Child Object in a Realtime Database on Firebase Admin SDK

Description:Emit new event when a new child object is discovered within a specific path

Version:0.0.6

Key:firebase_admin_sdk-new-child-object

View on GitHub

Firebase Admin SDK Overview#

The Firebase Admin SDK API provides powerful backend functionality for Firebase apps. It allows you to interact with Firebase services like Firestore, Firebase Realtime Database, Firebase Storage, and Firebase Authentication directly from a server. With Pipedream, you can harness this API to automate complex workflows, respond to Firebase events in real-time, and integrate with countless other services.

Trigger Code#

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

export default {
  ...common,
  key: "firebase_admin_sdk-new-child-object",
  name: "New Child Object in a Realtime Database",
  description: "Emit new event when a new child object is discovered within a specific path",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    path: {
      propDefinition: [
        common.props.firebase,
        "path",
      ],
    },
  },
  methods: {
    ...common.methods,
    async processEvent(event) {
      const { timestamp } = event;
      const ref = this.firebase.getApp().database()
        .ref(this.path);
      const snapshot = await ref.get();
      const children = snapshot.val() || {};
      for (const [
        key,
        value,
      ] of Object.entries(children)) {
        const meta = this.generateMeta(key, timestamp);
        const child = {
          [key]: value,
        };
        this.$emit(child, meta);
      }
    },
    generateMeta(key, timestamp) {
      return {
        id: key,
        summary: `New child object: ${key}`,
        ts: timestamp,
      };
    },
  },
};

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
Firebase Admin SDK	`firebase`	`app`	This component uses the Firebase Admin SDK app.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database Region	`databaseRegion`	`string`	Select a value from the drop down menu:`{ "label": "us-central1", "value": "firebaseio.com" }{ "label": "europe-west1", "value": "europe-west1.firebasedatabase.app" }{ "label": "asia-southeast1", "value": "asia-southeast1.firebasedatabase.app" }`
Path	`path`	`string`	A relative path to the location of child data

Trigger Authentication#

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

Enable the Cloud Firestore API on your Firebase account, and make sure you've created at least one collection in the database.
Follow these instructions to generate a private key tied to your Firebase service account. This will generate a JSON file that contains the project ID, private key, and client email that you should paste below.
When entering the private key, please add the full string included in the JSON file, from -----BEGIN PRIVATE KEY----- to -----END PRIVATE KEY-----, with all newline characters included.

About Firebase Admin SDK#

Firebase is Google's mobile platform that helps you quickly develop high-quality apps and grow your business.

Action#

Create Image (Dall-E) on OpenAI (ChatGPT)

Description:Creates an image given a prompt returning a URL to the image. [See the documentation](https://platform.openai.com/docs/api-reference/images)

Version:0.1.18

Key:openai-create-image

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:

Action Code#

import openai from "../../openai.app.mjs";
import constants from "../../common/constants.mjs";
import fs from "fs";

export default {
  name: "Create Image (Dall-E)",
  version: "0.1.18",
  key: "openai-create-image",
  description: "Creates an image given a prompt returning a URL to the image. [See the documentation](https://platform.openai.com/docs/api-reference/images)",
  type: "action",
  props: {
    openai,
    model: {
      label: "Model",
      description: "Choose the DALL·E models to generate image(s) with.",
      type: "string",
      options: constants.IMAGE_MODELS,
      reloadProps: true,
    },
    prompt: {
      label: "Prompt",
      description: "A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.",
      type: "string",
    },
    responseFormat: {
      label: "Response Format",
      description: "The format in which the generated images are returned.",
      type: "string",
      optional: true,
      options: constants.IMAGE_RESPONSE_FORMATS,
      default: "url",
      reloadProps: true,
    },
    size: {
      label: "Size",
      description: "The size of the generated images.",
      type: "string",
      optional: true,
      options: constants.IMAGE_SIZES,
      default: "1024x1024",
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.model && !this.responseFormat) {
      return props;
    }
    if (this.responseFormat === "tmp") {
      props.filename = {
        type: "string",
        label: "Filename",
        description: "Filename of the new file in `/tmp` directory. Make sure to include the extension.",
      };
    }
    if (this.model && this.model !== "dall-e-3") {
      props.n = {
        type: "integer",
        label: "N",
        description: "The number of images to generate. Must be between 1 and 10.",
        optional: true,
        default: 1,
      };
    } else {
      props.quality = {
        type: "string",
        label: "Quality",
        description: "The quality of the image",
        options: constants.IMAGE_QUALITIES,
        optional: true,
        default: "standard",
      };
      props.style = {
        type: "string",
        label: "Style",
        description: "The style of the image",
        options: constants.IMAGE_STYLES,
        optional: true,
        default: "natural",
      };
    }
    return props;
  },
  async run({ $ }) {
    const response = await this.openai.createImage({
      $,
      data: {
        prompt: this.prompt,
        n: this.n,
        size: this.size,
        response_format: this.responseFormat === "url"
          ? this.responseFormat
          : "b64_json",
        model: this.model,
        quality: this.quality,
        style: this.style,
      },
    });

    if (this.responseFormat === "tmp") {
      const n = this.n || 1;
      const fileData = [];
      for (let i = 0; i < n; i++) {
        // if N > 0, name subsequent files "filename_1.ext", "filename_2.ext", etc.
        const filename = i === 0
          ? this.filename
          : this.filename.replace(/(\.[^/.]+)$/, `_${i}$1`);
        const outputFilePath = filename.includes("tmp/")
          ? filename
          : `/tmp/${filename}`;
        await fs.writeFileSync(outputFilePath, Buffer.from(response.data[0].b64_json.toString(), "base64"));
        fileData.push({
          tmp: [
            filename,
            outputFilePath,
          ],
        });
      }
      response.data = fileData;
    }

    if (response.data.length) {
      $.export("$summary", `Successfully created ${response.data.length} image${response.data.length === 1
        ? ""
        : "s"}`);
    }

    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
OpenAI (ChatGPT)	`openai`	`app`	This component uses the OpenAI (ChatGPT) app.
Model	`model`	`string`	Select a value from the drop down menu:`dall-e-2dall-e-3`
Prompt	`prompt`	`string`	A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`{ "label": "URL", "value": "url" }{ "label": "Write file to /tmp directory", "value": "tmp" }{ "label": "Base64 JSON", "value": "b64_json" }`
Size	`size`	`string`	Select a value from the drop down menu:`256x256512x5121024x10241792x10241024x1792`

Action 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.

More Ways to Connect OpenAI (ChatGPT) + Firebase Admin SDK#

Other Popular Integrations#

Create Image with OpenAI (ChatGPT) API on New Document in Firestore Collection from Firebase Admin SDK API

Firebase Admin SDK + OpenAI (ChatGPT)

Create Image (Dall-E) with OpenAI (ChatGPT) API on New Child Object in a Realtime Database from Firebase Admin SDK API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular