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):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):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.
| Export | Purpose |
|---|---|
Player | ABR HLS + WebRTC playback with WAI-ARIA keyboard shortcuts |
Broadcast | WebRTC (WHIP) browser-based publishing |
Player.Root, Player.Video, Player.Container | Composable primitives for custom player UI |
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.
Related Pages
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.