FastPix Node.js SDK

The FastPix Node.js SDK is a type-safe Node.js client for the FastPix video API. From any Node.js application you can upload and manage videos, run live streams and simulcasts, create and secure playback IDs, manage playlists and signing keys, pull video analytics, verify webhooks, and use in-video AI features. It ships TypeScript types and works with both ES modules (ESM) and CommonJS.

Find more in the SDK reference

For all methods, runnable examples, and advanced usage, see the FastPix Node.js SDK on GitHub.

Before you begin

Make sure you have:

• Node.js 18 or later
• npm
• A FastPix account
• A FastPix Access Token and Secret Key, generated from the FastPix Dashboard. See Activate your account.

FastPix uses HTTP Basic Authentication. The SDK maps your credentials as follows:

Security: Never commit your Access Token or Secret Key to source control. Use environment variables or a secure credential-management system.

Follow the steps below in order, and do not skip the verification steps. If installation, the ES module configuration, authentication, client initialization, or the first API request fails, fix that problem before continuing.

Check your Node.js version

node --version

The output is similar to v20.19.0 or a later version. The SDK supports Node.js 18 and later. If your version is earlier than 18, install a supported version before continuing.

You can also check your npm version:

npm --version

Create a Node.js project

Create a directory for your application and initialize a Node.js project:

mkdir fastpix-node-sdk-demo
cd fastpix-node-sdk-demo
npm init -y

npm init -y creates a package.json file. Configure the project to use ES modules by adding "type": "module" to package.json:

{
  "name": "fastpix-node-sdk-demo",
  "version": "1.0.0",
  "type": "module",
  "main": "example.js",
  "scripts": {
    "start": "node example.js"
  }
}

The "type": "module" setting tells Node.js to treat .js files as ES modules, so you can use import { Fastpix } from "@fastpix/fastpix-node"; instead of require(...).

Install the FastPix SDK

Install the FastPix Node.js SDK with npm:

npm install @fastpix/fastpix-node

The SDK is added to your project’s dependencies and installed in node_modules. You can confirm the installed package:

npm list @fastpix/fastpix-node

Verify the SDK installation

Confirm that Node.js can import the SDK. Create a file named example.js:

import { Fastpix } from "@fastpix/fastpix-node";
console.log("FastPix SDK imported successfully");

Run it:

node example.js

The expected output is FastPix SDK imported successfully. If it fails, confirm that Node.js 18 or later is installed, "type": "module" is set in package.json, @fastpix/fastpix-node is installed, and you are running the command from the project directory.

Configure authentication

FastPix uses HTTP Basic Authentication, where username is your Access Token and password is your Secret Key. For local development, set these as environment variables so they stay out of your source code:

# macOS and Linux
export FASTPIX_USERNAME="<YOUR_ACCESS_TOKEN>"
export FASTPIX_PASSWORD="<YOUR_SECRET_KEY>"

# Windows PowerShell
$env:FASTPIX_USERNAME="<YOUR_ACCESS_TOKEN>"
$env:FASTPIX_PASSWORD="<YOUR_SECRET_KEY>"

Verify that your credentials are set

Check that both variables are set without printing their values:

node -e 'console.log("Access Token:", process.env.FASTPIX_USERNAME ? "set" : "missing"); console.log("Secret Key:", process.env.FASTPIX_PASSWORD ? "set" : "missing")'

Both should report set. If either is missing, set the corresponding environment variable before continuing.

Initialize the FastPix client

Replace the contents of example.js with:

import { Fastpix } from "@fastpix/fastpix-node";
const fastpix = new Fastpix({
  security: {
    username: process.env.FASTPIX_USERNAME,
    password: process.env.FASTPIX_PASSWORD,
  },
});
console.log("FastPix client initialized");

Run it:

node example.js

The expected output is FastPix client initialized. Initializing the client does not make an API request; a request happens only when you call an SDK operation such as fastpix.inputVideo.create(...).

Make your first API request

The easiest way to verify the integration is to create media from a publicly accessible video URL. FastPix provides a sample video at https://static.fastpix.com/fp-sample-video.mp4.

Replace the contents of example.js with:

import { Fastpix } from "@fastpix/fastpix-node";
const fastpix = new Fastpix({
  security: {
    username: process.env.FASTPIX_USERNAME,
    password: process.env.FASTPIX_PASSWORD,
  },
});
async function run() {
  const response = await fastpix.inputVideo.create({
    inputs: [
      {
        type: "video",
        url: "https://static.fastpix.com/fp-sample-video.mp4",
      },
    ],
    metadata: {
      source: "fastpix-node-sdk-demo",
    },
  });
  console.log(JSON.stringify(response, null, 2));
}
run().catch((error) => {
  console.error("FastPix API request failed");
  console.error(error);
  process.exit(1);
});

Run it:

node example.js

A successful request returns information about the newly created media asset, similar to:

{
  "success": true,
  "data": {
    "id": "5157e363-5abb-414d-83c7-520ecdc9f5fd",
    "status": "Created"
  }
}

The exact fields depend on the API response and the installed SDK version. A media_id is not the same as a playback_id. They identify different resources and are used for different operations.

Retrieve the media asset

Use the media ID returned by the create operation to retrieve the media asset. Replace the contents of example.js with:

import { Fastpix } from "@fastpix/fastpix-node";
const fastpix = new Fastpix({
  security: {
    username: process.env.FASTPIX_USERNAME,
    password: process.env.FASTPIX_PASSWORD,
  },
});
async function run() {
  console.log("Creating media...");
  const createResult = await fastpix.inputVideo.create({
    inputs: [
      {
        type: "video",
        url: "https://static.fastpix.com/fp-sample-video.mp4",
      },
    ],
    metadata: {
      source: "fastpix-node-sdk-demo",
    },
  });
  console.log("CREATE MEDIA", JSON.stringify(createResult, null, 2));
  const mediaId = createResult.data.id;
  console.log("\nMEDIA ID:", mediaId);
  console.log("\nRetrieving media...");
  const mediaResult = await fastpix.manageVideos.get({ mediaId });
  console.log("\nGET MEDIA", JSON.stringify(mediaResult, null, 2));
}
run().catch((error) => {
  console.error("\nFastPix API request failed");
  console.error(error);
  process.exit(1);
});

Run it:

node example.js

A successful response from the get-media operation confirms that the SDK authenticated, the media was created, a media ID was returned, and the media ID can be used in a subsequent API operation.

Verify the integration

A successful create-then-get flow confirms that Node.js is installed and supported, your project is configured to use ES modules, the SDK is installed and importable, your credentials are configured, the client can authenticate, and you can create and retrieve a media asset.

Creating media is usually the first step in a FastPix on-demand workflow: you create the media, poll it until processing finishes, then create a playback ID to play it. The initial SDK integration is now complete.

Resources, error handling, and reference

The SDK is generated from the FastPix API specification, so the complete and always-current reference lives in the repo and the API docs:

• All resources, operations, error handling, retries, server selection, custom HTTP clients, standalone (tree-shakeable) functions, webhooks, and debugging: the FastPix Node.js SDK on GitHub, with runnable code in the examples directory.
• Media (upload, manage, playback, playlists, signing keys, DRM): Video on Demand API.
• Live (streams, simulcasts, live playback): Live Stream API.
• Video Data (metrics, views, dimensions, errors): Video Data API.
• In-video AI (summaries, chapters, named entities, moderation): In-Video AI.

What’s next

Want to go further? Browse runnable, end-to-end samples for the FastPix Node.js SDK in the examples folder of the GitHub repository.

Release notes

For a complete history of releases, improvements, and fixes, see the FastPix Node.js SDK CHANGELOG on GitHub.