livepeer

Livepeer JavaScript Library

The Livepeer JavaScript library provides convenient access to the Livepeer Studio API from applications written in both browser and server-side JavaScript

Documentation

For full documentation and examples, please visit docs.livepeer.org.

Installation

Install the package with:

npm install livepeer
# or
yarn add livepeer

Summary

Livepeer API Reference: Welcome to the Livepeer API reference docs. Here you will find all the endpoints exposed on the standard Livepeer API, learn how to use them and what they return.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• File uploads
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

import { Livepeer } from "livepeer";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.create({
    name: "test_stream",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

accessControl

• create - Create a signing key
• getAll - Retrieves signing keys
• delete - Delete Signing Key
• get - Retrieves a signing key
• update - Update a signing key

asset

• getAll - Retrieve assets
• create - Upload an asset
• createViaUrl - Upload asset via URL
• get - Retrieves an asset
• update - Patch an asset
• delete - Delete an asset

generate

• textToImage - Text To Image
• imageToImage - Image To Image
• imageToVideo - Image To Video
• upscale - Upscale
• audioToText - Audio To Text
• segmentAnything2 - Segment Anything 2
• llm - LLM

metrics

• getRealtimeViewership - Query realtime viewership
• getViewership - Query viewership metrics
• getCreatorViewership - Query creator viewership metrics
• getPublicViewership - Query public total views metrics
• getUsage - Query usage metrics

multistream

• getAll - Retrieve Multistream Targets
• create - Create a multistream target
• get - Retrieve a multistream target
• update - Update Multistream Target
• delete - Delete a multistream target

playback

• get - Retrieve Playback Info

room

• create - Create a room :warning: Deprecated
• get - Retrieve a room :warning: Deprecated
• delete - Delete a room :warning: Deprecated
• startEgress - Start room RTMP egress :warning: Deprecated
• stopEgress - Stop room RTMP egress :warning: Deprecated
• createUser - Create a room user :warning: Deprecated
• getUser - Get user details :warning: Deprecated
• updateUser - Update a room user :warning: Deprecated
• deleteUser - Remove a user from the room :warning: Deprecated

session

• getClips - Retrieve clips of a session
• getAll - Retrieve sessions
• get - Retrieve a session
• getRecorded - Retrieve Recorded Sessions

stream

• create - Create a stream
• getAll - Retrieve streams
• get - Retrieve a stream
• update - Update a stream
• delete - Delete a stream
• terminate - Terminates a live stream
• startPull - Start ingest for a pull stream
• createClip - Create a clip
• getClips - Retrieve clips of a livestream
• addMultistreamTarget - Add a multistream target
• removeMultistreamTarget - Remove a multistream target

task

• getAll - Retrieve Tasks
• get - Retrieve a Task

transcode

• create - Transcode a video

webhook

• getAll - Retrieve a Webhook
• create - Create a webhook
• get - Retrieve a webhook
• update - Update a webhook
• delete - Delete a webhook
• getLogs - Retrieve webhook logs
• getLog - Retrieve a webhook log
• resendLog - Resend a webhook

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the get method may throw the following errors:

Error Type	Status Code	Content Type
errors.ErrorT	404	application/json
errors.SDKError	4XX, 5XX	*/*

import { Livepeer } from "livepeer";
import { ErrorT, SDKValidationError } from "livepeer/models/errors";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  let result;
  try {
    result = await livepeer.playback.get("<id>");

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ErrorT): {
        // Handle err.data$: ErrorTData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Livepeer } from "livepeer";
import { HTTPClient } from "livepeer/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Livepeer({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
apiKey	http	HTTP Bearer

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { Livepeer } from "livepeer";
import {
  Profile,
  TranscodeProfileEncoder,
  TranscodeProfileProfile,
  Type,
} from "livepeer/models/components";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.create({
    name: "test_stream",
    pull: {
      source: "https://myservice.com/live/stream.flv",
      headers: {
        "Authorization": "Bearer 123",
      },
      location: {
        lat: 39.739,
        lon: -104.988,
      },
    },
    playbackPolicy: {
      type: Type.Webhook,
      webhookId: "1bde4o2i6xycudoy",
      webhookContext: {
        "streamerId": "my-custom-id",
      },
      refreshInterval: 600,
    },
    profiles: [
      {
        width: 1280,
        name: "720p",
        height: 720,
        bitrate: 3000000,
        fps: 30,
        fpsDen: 1,
        quality: 23,
        gop: "2",
        profile: Profile.H264Baseline,
      },
    ],
    record: false,
    recordingSpec: {
      profiles: [
        {
          width: 1280,
          name: "720p",
          height: 720,
          bitrate: 3000000,
          quality: 23,
          fps: 30,
          fpsDen: 1,
          gop: "2",
          profile: TranscodeProfileProfile.H264Baseline,
          encoder: TranscodeProfileEncoder.H264,
        },
      ],
    },
    multistream: {
      targets: [
        {
          profile: "720p0",
          videoOnly: false,
          id: "PUSH123",
          spec: {
            name: "My target",
            url: "rtmps://live.my-service.tv/channel/secretKey",
          },
        },
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

• accessControlCreate - Create a signing key
• accessControlDelete - Delete Signing Key
• accessControlGet - Retrieves a signing key
• accessControlGetAll - Retrieves signing keys
• accessControlUpdate - Update a signing key
• assetCreate - Upload an asset
• assetCreateViaUrl - Upload asset via URL
• assetDelete - Delete an asset
• assetGet - Retrieves an asset
• assetGetAll - Retrieve assets
• assetUpdate - Patch an asset
• generateAudioToText - Audio To Text
• generateImageToImage - Image To Image
• generateImageToVideo - Image To Video
• generateLlm - LLM
• generateSegmentAnything2 - Segment Anything 2
• generateTextToImage - Text To Image
• generateUpscale - Upscale
• metricsGetCreatorViewership - Query creator viewership metrics
• metricsGetPublicViewership - Query public total views metrics
• metricsGetRealtimeViewership - Query realtime viewership
• metricsGetUsage - Query usage metrics
• metricsGetViewership - Query viewership metrics
• multistreamCreate - Create a multistream target
• multistreamDelete - Delete a multistream target
• multistreamGet - Retrieve a multistream target
• multistreamGetAll - Retrieve Multistream Targets
• multistreamUpdate - Update Multistream Target
• playbackGet - Retrieve Playback Info
• sessionGet - Retrieve a session
• sessionGetAll - Retrieve sessions
• sessionGetClips - Retrieve clips of a session
• sessionGetRecorded - Retrieve Recorded Sessions
• streamAddMultistreamTarget - Add a multistream target
• streamCreate - Create a stream
• streamCreateClip - Create a clip
• streamDelete - Delete a stream
• streamGet - Retrieve a stream
• streamGetAll - Retrieve streams
• streamGetClips - Retrieve clips of a livestream
• streamRemoveMultistreamTarget - Remove a multistream target
• streamStartPull - Start ingest for a pull stream
• streamTerminate - Terminates a live stream
• streamUpdate - Update a stream
• taskGet - Retrieve a Task
• taskGetAll - Retrieve Tasks
• transcodeCreate - Transcode a video
• webhookCreate - Create a webhook
• webhookDelete - Delete a webhook
• webhookGet - Retrieve a webhook
• webhookGetAll - Retrieve a Webhook
• webhookGetLog - Retrieve a webhook log
• webhookGetLogs - Retrieve webhook logs
• webhookResendLog - Resend a webhook
• webhookUpdate - Update a webhook
• roomCreate - Create a room :warning: Deprecated
• roomCreateUser - Create a room user :warning: Deprecated
• roomDelete - Delete a room :warning: Deprecated
• roomDeleteUser - Remove a user from the room :warning: Deprecated
• roomGet - Retrieve a room :warning: Deprecated
• roomGetUser - Get user details :warning: Deprecated
• roomStartEgress - Start room RTMP egress :warning: Deprecated
• roomStopEgress - Stop room RTMP egress :warning: Deprecated
• roomUpdateUser - Update a room user :warning: Deprecated

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Livepeer } from "livepeer";
import { openAsBlob } from "node:fs";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.generate.imageToImage({
    image: await openAsBlob("example.file"),
    prompt: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Livepeer } from "livepeer";
import {
  Profile,
  TranscodeProfileEncoder,
  TranscodeProfileProfile,
  Type,
} from "livepeer/models/components";

const livepeer = new Livepeer({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.create({
    name: "test_stream",
    pull: {
      source: "https://myservice.com/live/stream.flv",
      headers: {
        "Authorization": "Bearer 123",
      },
      location: {
        lat: 39.739,
        lon: -104.988,
      },
    },
    playbackPolicy: {
      type: Type.Webhook,
      webhookId: "1bde4o2i6xycudoy",
      webhookContext: {
        "streamerId": "my-custom-id",
      },
      refreshInterval: 600,
    },
    profiles: [
      {
        width: 1280,
        name: "720p",
        height: 720,
        bitrate: 3000000,
        fps: 30,
        fpsDen: 1,
        quality: 23,
        gop: "2",
        profile: Profile.H264Baseline,
      },
    ],
    record: false,
    recordingSpec: {
      profiles: [
        {
          width: 1280,
          name: "720p",
          height: 720,
          bitrate: 3000000,
          quality: 23,
          fps: 30,
          fpsDen: 1,
          gop: "2",
          profile: TranscodeProfileProfile.H264Baseline,
          encoder: TranscodeProfileEncoder.H264,
        },
      ],
    },
    multistream: {
      targets: [
        {
          profile: "720p0",
          videoOnly: false,
          id: "PUSH123",
          spec: {
            name: "My target",
            url: "rtmps://live.my-service.tv/channel/secretKey",
          },
        },
      ],
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Livepeer } from "livepeer";
import {
  Profile,
  TranscodeProfileEncoder,
  TranscodeProfileProfile,
  Type,
} from "livepeer/models/components";

const livepeer = new Livepeer({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await livepeer.stream.create({
    name: "test_stream",
    pull: {
      source: "https://myservice.com/live/stream.flv",
      headers: {
        "Authorization": "Bearer 123",
      },
      location: {
        lat: 39.739,
        lon: -104.988,
      },
    },
    playbackPolicy: {
      type: Type.Webhook,
      webhookId: "1bde4o2i6xycudoy",
      webhookContext: {
        "streamerId": "my-custom-id",
      },
      refreshInterval: 600,
    },
    profiles: [
      {
        width: 1280,
        name: "720p",
        height: 720,
        bitrate: 3000000,
        fps: 30,
        fpsDen: 1,
        quality: 23,
        gop: "2",
        profile: Profile.H264Baseline,
      },
    ],
    record: false,
    recordingSpec: {
      profiles: [
        {
          width: 1280,
          name: "720p",
          height: 720,
          bitrate: 3000000,
          quality: 23,
          fps: 30,
          fpsDen: 1,
          gop: "2",
          profile: TranscodeProfileProfile.H264Baseline,
          encoder: TranscodeProfileEncoder.H264,
        },
      ],
    },
    multistream: {
      targets: [
        {
          profile: "720p0",
          videoOnly: false,
          id: "PUSH123",
          spec: {
            name: "My target",
            url: "rtmps://live.my-service.tv/channel/secretKey",
          },
        },
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Livepeer } from "livepeer";

const sdk = new Livepeer({ debugLogger: console });