Create Image (Dall-E) with OpenAI (ChatGPT) API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub 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 GitHub 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 Commit Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
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 Commit Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.8

Key:github-new-commit-comment

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-commit-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.8",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

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`

Create Image (Dall-E) with OpenAI (ChatGPT) API on New Commit Comment from GitHub API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), GitHub 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