OpenAI

OverviewCopy Anchor Link

• OpenAIImageGenService: turns each TextFrame it receives into a prompt for OpenAI's Images API (images.generate) and pushes the result as a URLImageRawFrame of RGB pixels.

InstallationCopy Anchor Link

bun add @pipedog/openai

import { OpenAIImageGenService } from "@pipedog/openai/image";

PrerequisitesCopy Anchor Link

• An OpenAI account and an API key from the OpenAI dashboard.
• Pass the key as apiKey (required). The examples read it from OPENAI_API_KEY.

OpenAIImageGenServiceCopy Anchor Link

ConfigurationCopy Anchor Link

SettingsCopy Anchor Link

Runtime-updatable settings, passed as settings: new OpenAIImageGenService.Settings({...}) (OpenAIImageGenSettings). Any setting you leave out keeps the default below.

UsageCopy Anchor Link

import { OpenAIImageGenService } from "@pipedog/openai/image";

const imageGen = new OpenAIImageGenService({
  apiKey: process.env.OPENAI_API_KEY ?? "",
  settings: new OpenAIImageGenService.Settings({
    model: "gpt-image-2.5-flare",
    imageSize: "1024x1024",
    quality: "low",
  }),
});

NotesCopy Anchor Link

• Each TextFrame is pushed on downstream, then used as the prompt. One image is generated per prompt (n: 1).
• The GPT Image models return the image inline (base64). When the response carries a URL instead, the image is downloaded with fetch (the global one, or the fetch option) and the URL is set on the frame.
• The image is decoded to RGB (alpha dropped) with decodePngToRgb, a pure JS PNG decoder. Pass decodeImage to decode other formats.
• A response with no image data produces an ErrorFrame.
• As upstream, the constructor passes only settings to the base service, so the inherited frame processor options (such as name) have no effect.

Runtime notesCopy Anchor Link

Generated from pipecat.runtimes and pipecat.compat in packages/openai/package.json: ✅ means the compat smoke test passes on that runtime.

• The client is the openai JS SDK over fetch, and decoding is pure JS (fast-png), so it works on Bun, Node, Deno and Cloudflare Workers.
• The fetch option replaces upstream's required aiohttp_session. decodeImage is a pipedog addition; upstream decodes with Pillow.
• The deprecated imageSize and model constructor options are not ported. Use settings.
• For Azure OpenAI image generation, see AzureImageGenServiceREST.