API Reference

SDKs

Catalyst

What's New

Community

Livepeer Docs

Documentation

Dashboard

Discord

Awesome Livepeer

Explore APIs, guides, and examples to integrate with Livepeer.

Introduction

Learn how to create an API key and start adding live and on-demand video to your app or website!

Quickstart

Practical step-by-step guides to help you achieve a specific goal. These guides are designed to help you get started with a specific task or feature.

Learn how to upload and play back an asset

Upload an asset

Play an asset

Learn how to automatically upload and play back a video on IPFS and Arweave with Livepeer React

Play video from IPFS/Arweave

Learn how to listen to asset events using Studio webhooks.

Listen to asset events

Learn how to upload and play back an encrypted video asset

Upload encrypted assets

Learn how to mint a video NFT on the Aptos or an EVM-compatible blockchain with Livepeer React

Mint a video NFT

Learn how to retrieve thumbnails for a video asset

Get an asset thumbnail

Create a livestream

Learn how to use a media player with Livepeer

Play a livestream

Learn how to stream into Livepeer Studio with OBS

Livestream via OBS

In-browser broadcasting

Learn how to optimize latency for your Livepeer Studio workflow.

Optimize latency

Learn how to monitor stream metrics on Livepeer

Monitor stream health

Learn how to listen to stream events using Studio webhooks

Listen to stream events

Set up a multistream

Learn how to create clips from your livestream

Clip a livestream

Learn how to retrieve thumbnails for a live stream

Get a livestream thumbnail

Learn how to add access control to a content with React, using webhooks

Control access using webhooks

Learn how to add access control to a content with Livepeer React, using JWTs

Control access using JWTs

Learn how to set up a webhook using Node.js and Ngrok to receive notifications from Livepeer.

Set up and listen for webhooks

Transcode with Storj

Transcode with W3S

Learn how to check out viewer engagement on Livepeer

Engagement via API

Learn how to visualize your rngagement metrics with Grafana

Engagement via Grafana

Learn how to analyze Livepeer video engagement metrics with Timeplus

Engagement via Timeplus

Learn how to Build a decentralized video application with FVM and Livepeer

Youtube clone with FVM

Learn how to token gate videos using Livepeer and Lit: A step-by-step tutorial

Token gate videos with Lit

Bridge LPT to Arbitrum

Migrate stake to Arbitrum

Get started

Learn how to install go-livepeer and become an orchestrator

Install Go Livepeer

Connect to Arbitrum

Reward Calls

Set Session Limits

Set Pricing

Benchmark Transcoding

Assess concurrent stream

Monitor Metrics

Vote on proposals

Dual Mine

Connect to Transcoders

Migrate to Arbitrum

Migrate Stake from Contract

Broadcaster Introspection

Troubleshoot

What is Catalyst?

Running Catalyst

Developing with Catalyst

API Support Matrix

Bandwidth Requirements

CLI Reference

GPU Support

Hardware Requirements

Prometheus Metrics

Addresses of deployed contracts of the Livepeer protocol on various networks.

Contract Addresses

Curated collection of Livepeer example applications and integrations

Example Applications

Player

The toolkit you need to build with Livepeer

Learn how to create your first stream using the Livepeer Javascript SDK.

JavaScript

Learn how to create your first stream using the Livepeer Ruby SDK.

Ruby

Learn how to create your first stream using the Livepeer Go SDK.

Golang

Learn how to create your first stream using the Livepeer Python SDK.

Python

Get started building with Livepeer React!

Getting Started

The livepeer Client is a framework agnostic client that manages wallet connection state and configuration, such as: auto-connection, connectors, and ethers providers.

Client

The LivepeerConfig component manages configuration for all hooks using React Context.

LivepeerConfig

The Player component provides an easy way to display video or audio.

The Broadcast component provides an easy way to livestream video or audio.

Broadcast

useCreateAsset

useAsset

useUpdateAsset

React Hook for retrieving metrics for an asset.

useAssetMetrics

useCreateStream

useStream

useUpdateStream

React Hook for retrieving a stream session.

useStreamSession

React Hook for retrieving the stream sessions associated with a stream ID.

useStreamSessions

React Hook for retrieving playback details for a playback ID.

usePlaybackInfo

Application Binary Interface

All contract addresses for the Livepeer protocol.

Authentication

The Streams API is used to create, retrieve, update, delete stream object from pipeline.

Create a stream

Retrieve a stream

Update a stream

Terminates a  stream

Add a multistream target

Remove a multistream target

Delete a stream

Retrieve all streams

Create a clip

Retrieve clips of a livestream

The Multistream target API is used to create, retrieve, update, delete multi-stream targets object from pipeline.

Create a multistream

Retrieve a multistream

Update a multistream

Delete a multistream

Retrieve all multistreams

The Webhooks API is used to create, retrieve, update, delete webhooks object from pipeline.

Create a webhook

Retrieve a webhook

Update a webhook

Delete a webhook

Retrieve all webhooks

The Assets API is used to create, retrieve, update, delete assets object from pipeline.

Upload asset via URL

Retrieve an asset

Update an asset

Delete an asset

Retrieve assets

The Sessions API is used to retrieve sessions object from pipeline.

Retrieve a session

Retrieve all sessions

Retrieve recorded sessions

Retrieve clips of a session

The Access control API is used to create, retrieve, update, delete signing keys object from pipeline.

Getting Started

Guides

References

Core Concepts

Awesome Livepeer