View as Markdown
OpenAI (ChatGPT) icon

OpenAI (ChatGPT) ACTION

Chat using Web Search

Chat using the web search tool. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OpenAI (ChatGPT) account once, then configure and run Chat using Web Search 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-using-web-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openai: { authProvisionId: "apn_xxxxxxx" },
    modelId: "Model",
    input: "Chat 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 using Web Search inputs
Property Type Description
modelId Model string
Model used to generate the response
Required
input Chat Input string
Text inputs 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's larger than the context window size
Optional
userLocation User Location string[]
Additional configuration for approximate location parameters for the search
Optional
searchContextSize Search Context Size string
Determines the amount of context to use during the web search
Optional
responseFormat Response Format string
Optional
skipThisStep Skip This Step boolean
Pass in a boolean custom expression to skip this step's execution at runtime
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-using-web-search
Version
0.0.10
App
OpenAI (ChatGPT)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes