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 Video REST API

The Video REST API covers stream management, VOD asset upload and playback, webhooks, access control, viewership metrics, and transcode jobs. It is the API the Video SDK family (livepeer npm/pip/go/maven packages) wraps. Base URL: https://livepeer.com/api Authentication: Bearer token in the Authorization header. API keys are managed in the Livepeer developer dashboard. OpenAPI spec: The full machine-readable specification is available from the Livepeer developer portal (OpenAPI 3.0). Key resource groups:

AI Gateway Inference API

The AI inference API is served by the Livepeer gateway for AI workloads. Each pipeline type has a dedicated endpoint. The gateway routes requests to network orchestrators running the ai-runner container. Base URL: Gateway-dependent. Community gateway: https://dream-gateway.livepeer.cloud. Self-hosted gateways use the configured HTTP address. Authentication: Bearer token when the gateway requires it; the community gateway accepts unauthenticated requests for development. OpenAPI spec: Generated from the ai-runner OpenAPI specification. Available at https://docs.livepeer.org/api/ai-worker.yaml. Pipeline endpoints:
EndpointMethodPipeline
/text-to-imagePOSTText prompt to image
/image-to-imagePOSTImage + prompt to transformed image
/image-to-videoPOSTImage to short video
/image-to-textPOSTImage to caption
/audio-to-textPOSTAudio to transcript
/text-to-speechPOSTText to audio
/upscalePOSTImage upscaling
/segment-anything-2POSTImage segmentation
/llmPOSTOpenAI-compatible chat completions
/live/video-to-videoPOSTReal-time AI stream session (trickle)
See for endpoint schemas and curl examples.

Go-Livepeer Node API

go-livepeer nodes expose two local HTTP interfaces: the CLI interface (used by livepeer_cli) and the Prometheus metrics endpoint. CLI interface: http://<cliAddr>/ (default: http://127.0.0.1:7935/) Used by livepeer_cli for node management operations: deposit funding, status queries, configuration updates. Metrics endpoint: http://<cliAddr>/metrics Exposes Prometheus-format metrics for scraping. Enable with the -metrics flag on node startup. See for the key metric names and monitoring setup. The node API is local-only by default. Do not expose it externally without access controls.

SDKs

SDK packages that wrap the Video and AI APIs.

AI Pipelines

AI inference API endpoint shapes and request schemas.

Access Control

Access control signing key API for JWT-gated playback.

Viewership

Viewership metrics API for engagement and performance data.
Last modified on May 26, 2026