View as Markdown
OpenAI (ChatGPT) icon

OpenAI (ChatGPT) ACTION

Chat With Responses API

Send a chat via the Responses API, mixing built-in tools and MCP server tools. 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 Responses API 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-responses-api",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openai: { authProvisionId: "apn_xxxxxxx" },
    modelId: "Model",
    input: "Input",
  },
})

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 Responses API inputs
Property Type Description
modelId Model string
Model used to generate the response
Required Dynamic
input Input string
Text input to the model used to generate a response
Required
instructions Instructions string
Inserts a system (or developer) message as the first item in the model's context
Optional
previousResponseId Previous Response ID string
The unique ID of the previous response to the model. Use this to create multi-turn conversations
Optional
truncation Truncation string
Specifies the truncation mode for the response if it exceeds the context window
Optional
responseFormat Response Format string
  • text: Returns unstructured text output.
  • json_schema: Enforces a specific structure using a JSON schema.
Optional
builtInTools Built-In Tools string[]
Which of OpenAI's first-party tools to enable (web search, file search, code interpreter).
Required
otherTools Other Tools string[]
Other tools to include in the chat. See the documentation. Example: { type: "mcp", server_label: "gmail", server_url: "https://remote.mcp.pipedream.net", headers: {}, require_approval: "never" }
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-responses-api
Version
0.0.5
App
OpenAI (ChatGPT)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes