Skip to main content

Documentation Index

Fetch the complete documentation index at: https://na-36-merge-docs-v2-dev-draft-into-docs-v2-clean-20260525.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.


Livepeer publishes two families of client SDKs and one UI component library. All are generated from OpenAPI specifications and published to their respective package registries.

Video API SDKs

The Video API SDKs wrap the Livepeer REST API: streams, assets, webhooks, playback, access control, viewership metrics, and transcode jobs. All four are generated from the same OpenAPI spec. Initialisation (JavaScript):
import { Livepeer } from 'livepeer';
const client = new Livepeer({ apiKey: process.env.LIVEPEER_API_KEY });
Initialisation (Python):
from livepeer import Livepeer
client = Livepeer(api_key=os.environ['LIVEPEER_API_KEY'])
The JavaScript SDK supports Node.js, Bun, Deno, and browser runtimes. The SDK throws typed errors: SDKError for API-level errors, SDKValidationError for response schema mismatches.

AI Inference SDKs

The AI SDKs wrap the ai-runner gateway inference endpoints: all nine batch pipeline types. They are generated from the ai-runner OpenAPI specification and versioned independently from the Video API SDKs. Both AI SDKs are in alpha. Pin to a specific version to avoid breaking changes between releases. Initialisation (JavaScript):
import { Livepeer } from '@livepeer/ai';
const livepeer = new Livepeer({ httpBearer: '' }); // empty = community gateway
Initialisation (Python):
from livepeer_ai import Livepeer
client = Livepeer(http_bearer='')
See for method coverage and the generate namespace reference.
The livepeer/livepeer-ai-sdks repository is deprecated and no longer maintained. Use @livepeer/ai (npm) and livepeer-ai (PyPI) instead.

@livepeer/react (UI Kit)

@livepeer/react is the React component library for video playback and browser-based broadcasting. It is not a wrapper for the Video API; it is a UI component layer.
npm install @livepeer/react
Current version: 4.3.6. Supports React 17 and React 18. Key exports:
ExportPurpose
PlayerABR HLS + WebRTC playback with WAI-ARIA keyboard shortcuts
BroadcastWebRTC (WHIP) browser-based publishing
Player.Root, Player.Video, Player.ContainerComposable primitives for custom player UI
Repository: livepeer/ui-kit See for component usage and prop reference.

Deprecated SDKs

@livepeer/react-native (version 0.0.1) is no longer maintained. For React Native video playback, use react-native-video for HLS or react-native-webrtc for low-latency WebRTC.

AI SDKs

AI SDK method coverage, generate namespace, and gateway configuration.

Player

@livepeer/react Player props, ICE servers, and Broadcast component.

Video Overview

Video API SDK usage for streams, assets, and webhooks.

APIs

OpenAPI reference for the endpoints the SDKs wrap.
Last modified on May 26, 2026