Chat with Assistant with OpenAI (ChatGPT) API on New SMS Message Received from Bird API

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

Trigger workflow on

New SMS Message Received from the Bird API

Next, do this

Chat with Assistant 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 Bird 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 SMS Message Received trigger
1. Connect your Bird account
2. Configure timer
Configure the Chat with Assistant action
1. Connect your OpenAI (ChatGPT) account
2. Configure alert
3. Configure Message
4. Optional- Select a Assistant
5. Optional- Configure Name
6. Optional- Configure Instructions
7. Optional- Select a Model
8. Optional- Configure Thread ID
9. Optional- Select one or more Tool Types
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 SMS Message Received on Bird

Description:Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)

Version:0.0.1

Key:message_bird-new-sms-message-received

View on GitHub

Bird Overview#

Message Bird is a communications platform offering a suite of API solutions for sending messages, making voice calls, and conducting video conferences. With Pipedream, you can harness these capabilities to automate personalized notifications, streamline customer support, and facilitate global communication workflows. Message Bird's API on Pipedream allows you to send real-time alerts, trigger voice messages based on customer actions, and integrate with other services to create powerful, multi-channel communication systems.

Trigger Code#

import messagebird from "../../message_bird.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "message_bird-new-sms-message-received",
  name: "New SMS Message Received",
  description: "Emit new event when a new SMS message is received. [See the documentation](https://developers.messagebird.com/api/sms-messaging/#list-messages)",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  props: {
    messagebird,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: `New Message ID: ${message.id}`,
        ts: Date.parse(message.createdDatetime),
      };
    },
  },
  async run() {
    let lastTs = this._getLastTs();

    const { items } = await this.messagebird.listSMSMessages({
      params: {
        direction: "mo", // mt = sent, mo = received
        type: "sms",
        from: lastTs,
      },
    });

    if (!items?.length) {
      return;
    }

    for (const message of items) {
      const meta = this.generateMeta(message);
      this.$emit(message, meta);

      if (!lastTs || Date.parse(message.createdDatetime) > Date.parse(lastTs)) {
        lastTs = message.createdDatetime;
      }
    }

    this._setLastTs(lastTs);
  },
};

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

Trigger Authentication#

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

Once you sign in, the API key information are available in the Developer Settings, which is shown as Manage API Keys in the middle right of the Dashboard

About Bird#

Business in a box. Grow, Manage, Automate your company. Everything you need in one app.

Action#

Chat with Assistant on OpenAI (ChatGPT)

Description:Sends a message and generates a response, storing the message history for a continuous conversation. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)

Version:0.0.13

Key:openai-chat-with-assistant

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 common from "../common/common-assistants.mjs";

export default {
  ...common,
  key: "openai-chat-with-assistant",
  name: "Chat with Assistant",
  description: "Sends a message and generates a response, storing the message history for a continuous conversation. [See the documentation](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun)",
  version: "0.0.13",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    openai,
    alert: {
      type: "alert",
      alertType: "info",
      content: "Looking to chat with your tools? Check out our individual actions: [Chat using Web Search](https://pipedream.com/apps/openai/actions/chat-using-web-search), [Chat using File Search](https://pipedream.com/apps/openai/actions/chat-using-file-search), and [Chat using Functions](https://pipedream.com/apps/openai/actions/chat-using-functions).",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The message to send",
    },
    assistantId: {
      propDefinition: [
        openai,
        "assistant",
      ],
      description: "The assistant to use. Leave blank to create a new assistant",
      optional: true,
    },
    name: {
      propDefinition: [
        openai,
        "name",
      ],
    },
    instructions: {
      propDefinition: [
        openai,
        "instructions",
      ],
    },
    model: {
      propDefinition: [
        openai,
        "assistantModel",
      ],
      optional: true,
      default: "gpt-3.5-turbo",
    },
    threadId: {
      propDefinition: [
        openai,
        "threadId",
      ],
      description: "The unique identifier for the thread. Example: `thread_abc123`. Leave blank to create a new thread. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to \"Visible to organization owners\" or \"Visible to everyone\". You can then access the list of threads and click on individual threads to reveal their IDs",
      optional: true,
    },
    ...common.props,
  },
  async run({ $ }) {
    // create assistant if not provided
    let assistantId = this.assistantId;
    if (!assistantId) {
      const { id: newAssistantId } = await this.openai.createAssistant({
        $,
        data: {
          model: this.model,
          name: this.name,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
        },
      });
      assistantId = newAssistantId;
    }

    // create and run thread if no thread is provided
    let threadId = this.threadId;
    let run;
    if (!threadId) {
      run = await this.openai.createThreadAndRun({
        $,
        data: {
          assistant_id: assistantId,
          thread: {
            messages: [
              {
                role: "user",
                content: this.message,
              },
            ],
          },
          model: this.model,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
        },
      });
      threadId = run.thread_id;
    } else {
      // create run for thread if threadId is provided
      run = await this.openai.createRun({
        $,
        threadId: this.threadId,
        data: {
          assistant_id: assistantId,
          model: this.model,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
          additional_messages: [
            {
              role: "user",
              content: this.message,
            },
          ],
        },
      });
    }
    const runId = run.id;

    run = await this.pollRunUntilCompleted(run, threadId, runId, $);

    // get response;
    const { data: messages } = await this.openai.listMessages({
      $,
      threadId,
      params: {
        order: "desc",
      },
    });
    const response = messages[0].content[0].text.value;
    return {
      response,
      messages,
      run,
    };
  },
};

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.
Message	`message`	`string`	The message to send
Assistant	`assistantId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the assistant.
Instructions	`instructions`	`string`	The system instructions that the assistant uses.
Model	`model`	`string`	Select a value from the drop down menu.
Thread ID	`threadId`	`string`	The unique identifier for the thread. Example: `thread_abc123`. Leave blank to create a new thread. To locate the thread ID, make sure your OpenAI Threads setting (Settings -> Organization/Personal -> General -> Features and capabilities -> Threads) is set to "Visible to organization owners" or "Visible to everyone". You can then access the list of threads and click on individual threads to reveal their IDs
Tool Types	`toolTypes`	`string[]`	Select a value from the drop down menu:`code_interpreterfile_searchfunction`

Chat with Assistant with OpenAI (ChatGPT) API on New SMS Message Received from Bird API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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