Create Thread (Assistants) with OpenAI (ChatGPT) API on New Submission from ByteForms API

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

Trigger workflow on

New Submission from the ByteForms API

Next, do this

Create Thread (Assistants) 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 ByteForms 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 Submission trigger
1. Connect your ByteForms account
2. Configure timer
3. Select a Form ID
Configure the Create Thread (Assistants) action
1. Connect your OpenAI (ChatGPT) account
2. Optional- Configure Messages
3. Optional- Configure Metadata
4. Optional- Configure Run Thread
5. 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 Submission on ByteForms

Description:Emit new event when a user submission to a form occurs. [See the documentation](https://forms.bytesuite.io/docs/api#endpoints)

Version:0.0.1

Key:byteforms-new-submission

View on GitHub

Trigger Code#

import byteforms from "../../byteforms.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "byteforms-new-submission",
  name: "New Submission",
  description: "Emit new event when a user submission to a form occurs. [See the documentation](https://forms.bytesuite.io/docs/api#endpoints)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    byteforms,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    formId: {
      propDefinition: [
        byteforms,
        "formId",
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastCreated() {
      return this.db.get("lastCreated") || 0;
    },
    _setLastCreated(lastCreated) {
      this.db.set("lastCreated", lastCreated);
    },
    generateMeta(submission) {
      return {
        id: submission.id,
        summary: `New Form Submission: ${submission.id}`,
        ts: Date.parse(submission.created_at),
      };
    },
    async getSubmissions(max, lastCreated, params) {
      const submissions = [];
      do {
        const {
          cursor, data = [],
        } = await this.byteforms.listFormResponses({
          formId: this.formId,
          params,
        });
        if (!data?.length) {
          return submissions;
        }
        for (const item of data) {
          const ts = Date.parse(item.created_at);
          if (ts >= lastCreated) {
            submissions.push(item);
            if (max && submissions.length >= max) {
              return submissions;
            }
          } else {
            return submissions;
          }
        }
        params.after = cursor?.after;
      } while (params.after);
      return submissions;
    },
    async processEvent(max) {
      const lastCreated = this._getLastCreated();
      const params = {
        order: "desc",
      };
      const submissions = await this.getSubmissions(max, lastCreated, params);
      if (!submissions?.length) {
        return;
      }
      this._setLastCreated(Date.parse(submissions[0].created_at));
      submissions.forEach((submission) => {
        const meta = this.generateMeta(submission);
        this.$emit(submission, meta);
      });
    },
  },
  async run() {
    await this.processEvent();
  },
  sampleEmit,
};

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
ByteForms	`byteforms`	`app`	This component uses the ByteForms app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Form ID	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About ByteForms#

All-in-one solution for form creation, submission management, and data integration.

Action#

Create Thread (Assistants) on OpenAI (ChatGPT)

Description:Creates a thread with optional messages and metadata, and optionally runs the thread using the specified assistant. [See the documentation](https://platform.openai.com/docs/api-reference/threads/createThread)

Version:0.0.11

Key:openai-create-thread

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

export default {
  key: "openai-create-thread",
  name: "Create Thread (Assistants)",
  description: "Creates a thread with optional messages and metadata, and optionally runs the thread using the specified assistant. [See the documentation](https://platform.openai.com/docs/api-reference/threads/createThread)",
  version: "0.0.11",
  type: "action",
  props: {
    openai,
    messages: {
      propDefinition: [
        openai,
        "messages",
      ],
      optional: true,
    },
    metadata: {
      propDefinition: [
        openai,
        "metadata",
      ],
      optional: true,
    },
    runThread: {
      type: "boolean",
      label: "Run Thread",
      description: "Set to `true` to run the thread after creation",
      optional: true,
      reloadProps: true,
    },
    toolTypes: {
      type: "string[]",
      label: "Tool Types",
      description: "The types of tools to enable on the assistant",
      options: constants.TOOL_TYPES.filter((type) => type !== "function"),
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.runThread) {
      props.assistantId = {
        type: "string",
        label: "Assistant ID",
        description: "The unique identifier for the assistant.",
        options: async () => { return this.getAssistantPropOptions(); },
      };
      props.model = {
        type: "string",
        label: "Model",
        description: "The ID of the model to use for the assistant",
        options: async () => { return this.getAssistantModelPropOptions(); },
      };
      props.instructions = {
        type: "string",
        label: "Instructions",
        description: "The system instructions that the assistant uses.",
        optional: true,
      };
      props.waitForCompletion = {
        type: "boolean",
        label: "Wait For Completion",
        description: "Set to `true` to poll the API in 3-second intervals until the run is completed",
        optional: true,
      };
    }
    const toolProps = this.toolTypes?.length
      ? await this.getToolProps()
      : {};
    return {
      ...props,
      ...toolProps,
    };
  },
  methods: {
    ...common.methods,
    async getAssistantPropOptions() {
      const { data } = await this.openai.listAssistants();
      return data.map(({
        name, id,
      }) => ({
        label: name || id,
        value: id,
      }));
    },
    async getAssistantModelPropOptions() {
      const models = (await this.openai.models({})).filter(({ id }) => (id.includes("gpt-3.5-turbo") || id.includes("gpt-4-turbo")) && (id !== "gpt-3.5-turbo-0301"));
      return models.map(({ id }) => id);
    },
  },
  async run({ $ }) {
    const messages = this.messages?.length
      ? this.messages.map((message) => ({
        role: "user",
        content: message,
      }))
      : undefined;
    let response = !this.runThread
      ? await this.openai.createThread({
        $,
        data: {
          messages,
          metadata: this.metadata,
          tool_resources: this.buildToolResources(),
        },
      })
      : await this.openai.createThreadAndRun({
        $,
        data: {
          assistant_id: this.assistantId,
          thread: {
            messages,
            metadata: this.metadata,
          },
          model: this.model,
          instructions: this.instructions,
          tools: this.buildTools(),
          tool_resources: this.buildToolResources(),
          metadata: this.metadata,
        },
      });

    if (this.waitForCompletion) {
      const runId = response.id;
      const threadId = response.thread_id;
      response = await this.pollRunUntilCompleted(response, threadId, runId, $);
    }

    $.export("$summary", `Successfully created a thread ${this.runThread
      ? "and run"
      : ""} with ID: ${response.id}`);
    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.
Messages	`messages`	`string[]`	An array of messages to start the thread with.
Metadata	`metadata`	`object`	Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.
Run Thread	`runThread`	`boolean`	Set to `true` to run the thread after creation
Tool Types	`toolTypes`	`string[]`	Select a value from the drop down menu:`code_interpreterfile_search`

Create Thread (Assistants) with OpenAI (ChatGPT) API on New Submission from ByteForms API

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