View as Markdown
OpenAI (ChatGPT) icon

OpenAI (ChatGPT) ACTION

Create Batch

Creates and executes a batch from an uploaded file of requests. 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 Create Batch 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-create-batch",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    openai: { authProvisionId: "apn_xxxxxxx" },
    endpoint: "Endpoint",
    fileId: "File ID",
  },
})

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.

Create Batch inputs
Property Type Description
endpoint Endpoint string
The endpoint to be used for all requests in the batch
Required
fileId File ID string
The ID of the file to use for this request.
Optional Dynamic
filePath File Path or URL string
The .jsonl file to process. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.jpg)
Optional
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.
Optional
syncDir SyncDir dir
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-create-batch
Version
0.1.5
App
OpenAI (ChatGPT)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes