Create Image with Azure OpenAI Service API

Pipedream makes it easy to connect APIs for Azure OpenAI Service and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Image with the Azure OpenAI Service API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Image with the Azure OpenAI Service API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Image action
1. Connect your Azure OpenAI Service account
2. Configure Prompt
3. Optional- Configure N
4. Optional- Select a Size
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Image with Azure OpenAI Service API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Azure OpenAI Service

Try it

Create Image with Azure OpenAI Service API on New Submission from Typeform API

Typeform + Azure OpenAI Service

Try it

Create Image with Azure OpenAI Service API on Custom Events from Zoom API

Zoom + Azure OpenAI Service

Try it

Create Image with Azure OpenAI Service API on New Submission (Instant) from Jotform API

Jotform + Azure OpenAI Service

Try it

Create Image with Azure OpenAI Service API on New Scheduled Tasks from Pipedream API

Pipedream + Azure OpenAI Service

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Image on Azure OpenAI Service

Description:Creates an image given a prompt, and returns a URL to the image. [See the documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#image-generation)

Version:0.0.1

Key:azure_openai_service-create-image

View on GitHub

Code#

import azureOpenAI from "../../azure_openai_service.app.mjs";
import constants from "../common/constants.mjs";
const delay = (ms) => new Promise((res) => setTimeout(res, ms));

export default {
  key: "azure_openai_service-create-image",
  name: "Create Image",
  description: "Creates an image given a prompt, and returns a URL to the image. [See the documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#image-generation)",
  version: "0.0.1",
  type: "action",
  props: {
    azureOpenAI,
    prompt: {
      label: "Prompt",
      description: "A text description of the desired image(s). The maximum length is 1000 characters.",
      type: "string",
    },
    n: {
      label: "N",
      description: "The number of images to generate. Must be between 1 and 10.",
      type: "integer",
      optional: true,
      default: 1,
    },
    size: {
      label: "Size",
      description: "The size of the generated images.",
      type: "string",
      optional: true,
      options: constants.IMAGE_SIZES,
      default: "1024x1024",
    },
  },
  async run({ $ }) {
    const { id: operationId } = await this.azureOpenAI.createImage({
      data: {
        prompt: this.prompt,
        n: this.n,
        size: this.size,
      },
      $,
    });

    let response;
    do {
      response = await this.azureOpenAI.getImageResult({
        operationId,
        $,
      });
      if (response?.status === "succeeded") {
        break;
      }
      await delay(5000);
    } while (true);

    if (response.id) {
      $.export("$summary", `Successfully created image with ID ${response.id}.`);
    }

    return response;
  },
};

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
Azure OpenAI Service	`azureOpenAI`	`app`	This component uses the Azure OpenAI Service app.
Prompt	`prompt`	`string`	A text description of the desired image(s). The maximum length is 1000 characters.
N	`n`	`integer`	The number of images to generate. Must be between 1 and 10.
Size	`size`	`string`	Select a value from the drop down menu:`256x256512x5121024x1024`

Authentication#

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

Before you start, you'll need to deploy a model in the Azure OpenAI Service.

Once that's done, enter the name of your Azure OpenAI resource, the deployment name you chose when you deployed the model, and your Azure OpenAI key below.