How do I install the PixelPanda JavaScript SDK?

npm install pixelpanda. The package has zero runtime dependencies, ships ESM and CommonJS builds with full TypeScript types, and supports Node 18 or newer.

AI background removal, 2x/4x/8x upscaling, photo enhancement, prompt-based editing (FLUX Kontext), image-to-prompt reverse engineering, AI product-scene photography, complete ad packs from a product URL, UGC video generation and async job polling.

What inputs does it accept?

Every image argument takes a local file path, raw bytes (Uint8Array or ArrayBuffer), or a public URL - the SDK handles upload encoding automatically.

How do async jobs work?

Generation methods wait for completion by default. Pass { wait: false } to receive a job_id immediately and poll with getJob or waitForJob.

Is there a Python SDK too?

Yes - pixelpanda-python on GitHub, plus a REST API, hosted MCP server, and integrations for Zapier, Make, n8n, Enfocus Switch and Fiery JobFlow.

JavaScript SDK

npm install pixelpanda

The official Node.js client for the PixelPanda API. Background removal, print-resolution upscaling, AI editing, product photography and ad packs — typed, zero-dependency, and three lines from your first result.

View on npm Source on GitHub

Dependencies

Typed API

10+

AI operations

import PixelPanda from "pixelpanda"; const pp = new PixelPanda("pk_live_..."); // or PIXELPANDA_API_KEY env // Upscale AI art to print resolution const up = await pp.upscale("midjourney_art.png", { scale: 4 }); // Remove a background → transparent PNG const cut = await pp.removeBackground("product.jpg"); // Edit with a prompt (FLUX Kontext) await pp.edit("photo.jpg", "make the background pure white"); // One product image → four AI scene photos const job = await pp.generateProductPhotos("product.jpg", { numPhotos: 4 }); // Full ad pack from a product page URL const pack = await pp.createAdPack("https://mystore.com/products/mug");

The Fastest Way to Add AI Images to a Node App

Whether you're building an e-commerce backend, a print pipeline or an internal tool, the SDK wraps the whole PixelPanda API in typed methods that accept a file path, bytes or URL and hand back hosted result URLs.

Everything in the API, one import

Clean-up — removeBackground, enhance, upscale (2x/4x/8x, print-ready).
Editing — edit(image, prompt) with FLUX Kontext; imageToPrompt for reverse-engineering AI art.
Generation — generateProductPhotos (one image in, scene photos out), uploadProduct + generateScenes, createAdPack from a product page URL, generateVideo for UGC clips.
Jobs — generation methods wait by default; { wait: false } + waitForJob when you want control.

Three Steps to First Result

Install

npm install pixelpanda — zero dependencies, ESM + CommonJS, full TypeScript types, Node 18+.

Authenticate

new PixelPanda(apiKey) or set PIXELPANDA_API_KEY. Free key at pixelpanda.ai — Profile, API Token.

Process

Pass a path, bytes or URL to upscale, removeBackground, edit, generateProductPhotos and more; get hosted result URLs back.

Frequently Asked Questions

How do I install the SDK?

npm install pixelpanda. Zero runtime dependencies, ESM and CommonJS builds, full TypeScript types, Node 18+.

What operations are supported?

Background removal, 2x/4x/8x upscaling, enhancement, prompt-based editing, image-to-prompt, product-scene generation, ad packs from a product URL, UGC video and job polling.

What inputs are accepted?

A local file path, raw bytes (Uint8Array/ArrayBuffer) or a public URL — encoding is handled automatically.

How much does it cost?

The SDK is free and MIT-licensed; API calls spend PixelPanda credits (most operations 1 credit).

Is the source available?

Yes — github.com/RyanKramer/pixelpanda-js, alongside a Python SDK and a dozen other integrations.