← OpenAI (ChatGPT)

Chat with OpenAI (ChatGPT) API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT) and 1400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Chat with the OpenAI (ChatGPT) API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to Chat with the OpenAI (ChatGPT) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Chat action
    1. Connect your OpenAI (ChatGPT) account
    2. Select a Model
    3. Configure User Message
    4. Optional- Configure System Instructions
    5. Optional- Configure Prior Message History
    6. Optional- Configure Max Tokens
    7. Optional- Configure Temperature
    8. Optional- Configure Top P
    9. Optional- Configure N
    10. Optional- Configure Stop
    11. Optional- Configure Presence Penalty
    12. Optional- Configure Frequency Penalty
    13. Optional- Configure User
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Chat with OpenAI (ChatGPT) API on New Requests from HTTP / Webhook API
HTTP / Webhook + OpenAI (ChatGPT)
 
Try it
Chat with OpenAI (ChatGPT) API on New Submission from Typeform API
Typeform + OpenAI (ChatGPT)
 
Try it
Chat with OpenAI (ChatGPT) API on New Submission (Instant) from Jotform API
Jotform + OpenAI (ChatGPT)
 
Try it
Chat with OpenAI (ChatGPT) API on New Custom Webhook Events from Stripe API
Stripe + OpenAI (ChatGPT)
 
Try it
Chat with OpenAI (ChatGPT) API on New Scheduled Tasks from Pipedream API
Pipedream + OpenAI (ChatGPT)
 
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.

Chat on OpenAI (ChatGPT)
Description:The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)
Version:0.1.2
Key:openai-chat

Code

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

export default {
  ...common,
  name: "Chat",
  version: "0.1.2",
  key: "openai-chat",
  description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See docs here](https://platform.openai.com/docs/api-reference/chat)",
  type: "action",
  props: {
    openai,
    modelId: {
      propDefinition: [
        openai,
        "chatCompletionModelId",
      ],
    },
    userMessage: {
      label: "User Message",
      type: "string",
      description: "The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.",
    },
    systemInstructions: {
      label: "System Instructions",
      type: "string",
      description: "The system message helps set the behavior of the assistant. For example: \"You are a helpful assistant.\" [See these docs](https://platform.openai.com/docs/guides/chat/instructing-chat-models) for tips on writing good instructions.",
      optional: true,
    },
    messages: {
      label: "Prior Message History",
      type: "string[]",
      description: "_Advanced_. Because [the models have no memory of past chat requests](https://platform.openai.com/docs/guides/chat/introduction), all relevant information must be supplied via the conversation. You can provide [an array of messages](https://platform.openai.com/docs/guides/chat/introduction) from prior conversations here. If this param is set, the action ignores the values passed to **System Instructions** and **Assistant Response**, appends the new **User Message** to the end of this array, and sends it to the API.",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    const args = this._getChatArgs();
    const response = await this.openai.createChatCompletion({
      $,
      args,
    });

    if (response) {
      $.export("$summary", `Successfully sent chat with id ${response.id}`);
    }

    const { messages } = args;
    return {
      original_messages: messages,
      original_messages_with_assistant_response: messages.concat(response.choices[0]?.message),
      ...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.
LabelPropTypeDescription
OpenAI (ChatGPT)openaiappThis component uses the OpenAI (ChatGPT) app.
ModelmodelIdstringSelect a value from the drop down menu.
User MessageuserMessagestring

The user messages provide instructions to the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.

System InstructionssystemInstructionsstring

The system message helps set the behavior of the assistant. For example: "You are a helpful assistant." See these docs for tips on writing good instructions.

Prior Message Historymessagesstring[]

Advanced. Because the models have no memory of past chat requests, all relevant information must be supplied via the conversation. You can provide an array of messages from prior conversations here. If this param is set, the action ignores the values passed to System Instructions and Assistant Response, appends the new User Message to the end of this array, and sends it to the API.

Max TokensmaxTokensinteger

The maximum number of tokens to generate in the completion.

Temperaturetemperaturestring

Optional. What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.

Top PtopPstring

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

Nninteger

How many completions to generate for each prompt

Stopstopstring[]

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

Presence PenaltypresencePenaltystring

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

Frequency PenaltyfrequencyPenaltystring

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

Useruserstring

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more here.

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 apps like ChatGPT and DALL·E 2.

More Ways to Use OpenAI (ChatGPT)

Actions

Summarize Text with the OpenAI (ChatGPT) API

Summarizes text using the Chat API

 
Try it
Classify Items into Categories with the OpenAI (ChatGPT) API

Classify items into specific categories using the Chat API

 
Try it
Translate Text with the OpenAI (ChatGPT) API

Translate text from one language to another using the Chat API

 
Try it
Create Transcription with the OpenAI (ChatGPT) API

Transcribes audio into the input language. See docs here.

 
Try it
Create Image with the OpenAI (ChatGPT) API

Creates an image given a prompt. returns a URL to the image. See docs here

 
Try it

Explore Other Apps

1
-
12
of
1400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Beta
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
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 apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
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.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.