← OpenAI (ChatGPT)

Create Thread (Assistants) with OpenAI (ChatGPT) API

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

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

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Thread (Assistants) 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 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
  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

Create Thread with OpenAI (ChatGPT) API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + OpenAI (ChatGPT)
 
Try it
Create Thread with OpenAI (ChatGPT) API on New Submission from Typeform API
Typeform + OpenAI (ChatGPT)
 
Try it
Create Thread with OpenAI (ChatGPT) API on Custom Events from Zoom API
Zoom + OpenAI (ChatGPT)
 
Try it
Create Thread with OpenAI (ChatGPT) API on New Submission (Instant) from Jotform API
Jotform + OpenAI (ChatGPT)
 
Try it
Create Thread 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.

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

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;
  },
};

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.
Messagesmessagesstring[]

An array of messages to start the thread with.

Metadatametadataobject

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 ThreadrunThreadboolean

Set to true to run the thread after creation

Tool TypestoolTypesstring[]Select a value from the drop down menu:code_interpreterfile_search

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 Use OpenAI (ChatGPT)

Triggers

New Batch Completed from the OpenAI (ChatGPT) API

Emit new event when a new batch is completed in OpenAI. See the documentation

 
Try it
New File Created from the OpenAI (ChatGPT) API

Emit new event when a new file is created in OpenAI. See the documentation

 
Try it
New Fine Tuning Job Created from the OpenAI (ChatGPT) API

Emit new event when a new fine-tuning job is created in OpenAI. See the documentation

 
Try it
New Run State Changed from the OpenAI (ChatGPT) API

Emit new event every time a run changes its status. See the documentation

 
Try it

Actions

Chat with the OpenAI (ChatGPT) API

The Chat API, using the gpt-3.5-turbo or gpt-4 model. See the documentation

 
Try it
Summarize Text with the OpenAI (ChatGPT) API

Summarizes text using the Chat API. See the documentation

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

Classify items into specific categories using the Chat API. See the documentation

 
Try it
Translate Text (Whisper) with the OpenAI (ChatGPT) API

Translate text from one language to another using the Chat API. See the documentation

 
Try it
Create Transcription (Whisper) with the OpenAI (ChatGPT) API

Transcribes audio into the input language. See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,400+
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.
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.
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 models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.