Chat with OpenAI (ChatGPT) API on New Sent API Message from Textlocal API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), Textlocal and 1,600+ other apps remarkably fast.

Trigger workflow on

New Sent API Message from the Textlocal API

Next, do this

Chat with the OpenAI (ChatGPT) API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Textlocal 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 Sent API Message trigger
1. Connect your Textlocal account
2. Configure timer
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 Images
7. Optional- Select a Response Format
8. Optional- Configure Max Tokens
9. Optional- Configure Temperature
10. Optional- Configure Top P
11. Optional- Configure N
12. Optional- Configure Stop
13. Optional- Configure Presence Penalty
14. Optional- Configure Frequency Penalty
15. Optional- Configure User
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 Sent API Message on Textlocal

Description:Emit new message sent via Textlocal's API

Version:0.0.4

Key:textlocal-new-sent-api-message

View on GitHub

Textlocal Overview#

You can do so much with the Textlocal API! Textlocal is an easy-to-use platform
for sending and receiving mobile and SMS messages, making it a great avenue for
businesses to communicate with their customers. Here are a few examples of what
you can build with the Textlocal API:

Automate SMS marketing campaigns to customers
Notify customers of special offers and discounts
Send reminders and appointment confirmations
Create location-based notifications
Receive two-way communication from customers
Integrate text alerts into other applications, like business workflows and
CRMs
Send mass notifications during emergencies

Trigger Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "textlocal-new-sent-api-message",
  name: "New Sent API Message",
  description: "Emit new message sent via Textlocal's API",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  hooks: {
    ...common.hooks,
    async activate() {
      let latestMessageId = this.db.get("latestMessageId");
      if (!latestMessageId) {
        latestMessageId = await this.textlocal.getLatestMessageId();
        this.db.set("latestMessageId", latestMessageId);
      }

      console.log(`Starting scanning from message ID: ${latestMessageId}`);
    },
  },
  methods: {
    ...common.methods,
    generateMeta(message) {
      const {
        id,
        datetime,
        number,
        sender,
      } = message;
      const maskedNumber = this.getMaskedNumber(number);
      const summary = `New message from ${sender} to ${maskedNumber}`;
      const ts = Date.parse(datetime);
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent() {
      const latestMessageId = this.db.get("latestMessageId");
      const messageScan = await this.textlocal.scanApiMessageHistory({
        lowerBoundMessageId: latestMessageId,
      });

      const messages = [];
      for await (const message of messageScan) {
        messages.push(message);
      }

      if (messages.length === 0) {
        console.log("No new messages detected. Skipping...");
        return;
      }

      messages.reverse().forEach((message) => {
        const meta = this.generateMeta(message);
        this.$emit(message, meta);
      });

      const newLatestMessageId = Math.max(
        ...messages.map(({ id }) => id),
      ).toString();
      this.db.set("latestMessageId", newLatestMessageId);
    },
  },
};

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
Textlocal	`textlocal`	`app`	This component uses the Textlocal app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Get your api key in your settings > API keys.

About Textlocal#

Bulk SMS Marketing Service for Business | Send ...

Action#

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

Key:openai-chat

View on GitHub

OpenAI (ChatGPT) Overview#

The OpenAI API is a powerful tool that provides access to a range of
high-powered machine learning models. With the OpenAI API, developers can
create products, services, and tools that enable humanizing AI experiences, and
build applications that extend the power of human language.

Using the OpenAI API, developers can create language-driven applications such
as:

Natural language understanding and sentiment analysis
Text-based search
Question answering
Dialogue systems and conversation agents
Intelligent text completion
Text summarization
Text classification
Machine translation
Language generation
Multi-factor authentication
Anomaly detection
Text analysis

Action Code#

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

export default {
  ...common,
  name: "Chat",
  version: "0.1.7",
  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,
    },
    images: {
      label: "Images",
      type: "string[]",
      description: "Provide one or more images to [OpenAI's vision model](https://platform.openai.com/docs/guides/vision). Accepts URLs or base64 encoded strings. Compatible with the `gpt4-vision-preview model`",
      optional: true,
    },
    responseFormat: {
      type: "string",
      label: "Response Format",
      description: "Specify the format that the model must output. [Setting to `json_object` guarantees the message the model generates is valid JSON](https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format). Defaults to `text`",
      options: [
        "text",
        "json_object",
      ],
      optional: true,
      default: "text",
    },
    ...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,
    };
  },
};

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	`modelId`	`string`	Select a value from the drop down menu.
User Message	`userMessage`	`string`	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 Instructions	`systemInstructions`	`string`	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 History	`messages`	`string[]`	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.
Images	`images`	`string[]`	Provide one or more images to OpenAI's vision model. Accepts URLs or base64 encoded strings. Compatible with the `gpt4-vision-preview model`
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`textjson_object`
Max Tokens	`maxTokens`	`integer`	The maximum number of tokens to generate in the completion.
Temperature	`temperature`	`string`	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 P	`topP`	`string`	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.
N	`n`	`integer`	How many completions to generate for each prompt
Stop	`stop`	`string[]`	Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Presence Penalty	`presencePenalty`	`string`	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 Penalty	`frequencyPenalty`	`string`	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.
User	`user`	`string`	A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more here.

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) + Textlocal#

Other Popular Integrations#

Create Contact with Textlocal API on New Fine Tuning Job Created from OpenAI (ChatGPT) API

OpenAI (ChatGPT) + Textlocal

Chat with OpenAI (ChatGPT) API on New Sent API Message from Textlocal API

Pipedream makes it easy to connect APIs for OpenAI (ChatGPT), Textlocal and 1,600+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-12of1,600+apps by most popular

1
-
12
of
1,600+
apps by most popular