The Livepeer JavaScript library provides convenient access to the Livepeer Studio API from applications written in both browser and server-side JavaScript
For full documentation and examples, please visit docs.livepeer.org.
Install the package with:
npm install livepeer
# or
yarn add livepeerLivepeer 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.
- SDK Installation
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Authentication
- Debugging
For supported JavaScript runtimes, please consult RUNTIMES.md.
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 methods
- create - Create a signing key
- getAll - Retrieves signing keys
- delete - Delete Signing Key
- get - Retrieves a signing key
- update - Update a signing key
- getAll - Retrieve assets
- create - Upload an asset
- createViaUrl - Upload asset via URL
- get - Retrieves an asset
- update - Patch an asset
- delete - Delete an asset
- textToImage - Text To Image
- imageToImage - Image To Image
- imageToVideo - Image To Video
- upscale - Upscale
- audioToText - Audio To Text
- segmentAnything2 - Segment Anything 2
- getRealtimeViewership - Query realtime viewership
- getViewership - Query viewership metrics
- getCreatorViewership - Query creator viewership metrics
- getPublicViewership - Query public total views metrics
- getUsage - Query usage metrics
- getAll - Retrieve Multistream Targets
- create - Create a multistream target
- get - Retrieve a multistream target
- update - Update Multistream Target
- delete - Delete a multistream target
- get - Retrieve Playback Info
create- Create a room⚠️ Deprecatedget- Retrieve a room⚠️ Deprecateddelete- Delete a room⚠️ DeprecatedstartEgress- Start room RTMP egress⚠️ DeprecatedstopEgress- Stop room RTMP egress⚠️ DeprecatedcreateUser- Create a room user⚠️ DeprecatedgetUser- Get user details⚠️ DeprecatedupdateUser- Update a room user⚠️ DeprecateddeleteUser- Remove a user from the room⚠️ Deprecated
- getClips - Retrieve clips of a session
- getAll - Retrieve sessions
- get - Retrieve a session
- getRecorded - Retrieve Recorded Sessions
- 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
- create - Transcode a video
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.ErrorT | 404 | application/json |
| errors.SDKError | 4xx-5xx | / |
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.
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();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 });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: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();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
- accessControlDelete
- accessControlGetAll
- accessControlGet
- accessControlUpdate
- assetCreateViaUrl
- assetCreate
- assetDelete
- assetGetAll
- assetGet
- assetUpdate
- generateAudioToText
- generateImageToImage
- generateImageToVideo
- generateSegmentAnything2
- generateTextToImage
- generateUpscale
- metricsGetCreatorViewership
- metricsGetPublicViewership
- metricsGetRealtimeViewership
- metricsGetUsage
- metricsGetViewership
- multistreamCreate
- multistreamDelete
- multistreamGetAll
- multistreamGet
- multistreamUpdate
- playbackGet
- roomCreateUser
- roomCreate
- roomDeleteUser
- roomDelete
- roomGetUser
- roomGet
- roomStartEgress
- roomStopEgress
- roomUpdateUser
- sessionGetAll
- sessionGetClips
- sessionGetRecorded
- sessionGet
- streamAddMultistreamTarget
- streamCreateClip
- streamCreate
- streamDelete
- streamGetAll
- streamGetClips
- streamGet
- streamRemoveMultistreamTarget
- streamStartPull
- streamTerminate
- streamUpdate
- taskGetAll
- taskGet
- transcodeCreate
- webhookCreate
- webhookDelete
- webhookGetAll
- webhookGetLog
- webhookGetLogs
- webhookGet
- webhookResendLog
- webhookUpdate
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
openAsBlobfunction innode:fs. - Bun: The native
Bun.filefunction produces a file handle that can be used for streaming file uploads. - Browsers: All supported browsers return an instance to a
Filewhen reading the value from an<input type="file">element. - Node.js v18: A file stream can be created using the
fileFromhelper fromfetch-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();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: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://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: "720p",
videoOnly: false,
id: "PUSH123",
spec: {
name: "My target",
url: "rtmps:https://live.my-service.tv/channel/secretKey",
},
},
],
},
});
// Handle the result
console.log(result);
}
run();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 });