View as Markdown
OpenAI (ChatGPT) icon

OpenAI (ChatGPT) ACTION

Chat with Assistant

Sends a message and generates a response, storing the message history for a continuous conversation. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OpenAI (ChatGPT) account once, then configure and run Chat with Assistant from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "openai-chat-with-assistant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openai: { authProvisionId: "apn_xxxxxxx" },
    message: "Message",
    assistantId: "Assistant",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Chat with Assistant inputs
Property Type Description
message Message string
The message to send
Required
assistantId Assistant string
The assistant to use. Leave blank to create a new assistant
Optional Dynamic
name Name string
The name of the assistant.
Optional
instructions Instructions string
The system instructions that the assistant uses.
Optional
model Model string
The ID of the model to use for the assistant
Optional Dynamic
threadId Thread ID 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
Optional
toolTypes Tool Types string[]
The types of tools to enable on the assistant
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
openai-chat-with-assistant
Version
0.0.15
App
OpenAI (ChatGPT)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes