Mux

Enables programmatic video file uploads to Mux's distributed infrastructure with support for direct file uploads, URL-based ingestion, and multipart streaming. The SDK abstracts the underlying HTTP client layer (APIClient.post/put methods) to handle authentication via token ID/secret pairs, automatic retry logic, and response parsing into typed Asset objects. Supports both synchronous uploads and asynchronous processing workflows where video transcoding happens server-side after ingestion.

Provides programmatic creation and management of live streaming sessions through Mux's Live API, exposing CRUD operations for live stream objects that generate RTMP ingest URLs and playback IDs. The SDK wraps the underlying APIClient methods to handle authentication and response marshaling, enabling developers to create streams with custom settings (resolution, bitrate, latency profiles), retrieve stream status, and terminate sessions. Live streams are created as persistent resources that can be reused across multiple broadcast sessions.

Provides automatic pagination handling for list operations that return large result sets. The SDK's list methods accept pagination parameters (limit, offset or cursor) and return paginated responses with metadata (total_count, has_more). Developers can iterate through pages manually or use helper methods that abstract away pagination logic. The SDK handles cursor-based pagination transparently, allowing developers to fetch all results without manually constructing pagination queries.

Provides structured error handling with automatic retry logic for transient failures. The SDK wraps API responses and translates HTTP error codes into typed error objects (APIError, RateLimitError, AuthenticationError, etc.) with detailed error messages and metadata. Automatic retry logic handles transient failures (5xx errors, timeouts) with exponential backoff, whereas permanent failures (4xx errors) fail immediately. Developers can configure retry behavior (max attempts, backoff strategy) through client options.

Enables configuration of playback restrictions and digital rights management (DRM) for video assets through the SDK's playback policy APIs. Developers can set signed playback tokens (JWT-based), geo-blocking rules, IP whitelisting, and DRM provider integration (Widevine, FairPlay) at the asset or stream level. The SDK provides JWT signing utilities (using jwtSigningKey and jwtPrivateKey) to generate time-limited, cryptographically signed playback tokens that restrict access to specific playback IDs.

Provides programmatic access to Mux's Data API for querying video engagement metrics, viewer analytics, and performance data. The SDK exposes methods to retrieve video views, playback metrics (bitrate, resolution, buffering), and custom dimensions/filters for segmenting data by geography, device type, or custom metadata. Queries are constructed through a fluent API that builds filter expressions and dimension selections, which are then executed via the APIClient.get() method and returned as structured metric objects.

Provides cryptographic verification of incoming Mux webhook events using HMAC-SHA256 signature validation. The SDK exposes a webhook verification method that accepts the raw request body and signature header, validates the signature against the configured webhookSecret, and returns the parsed event payload if valid. This prevents processing of forged or tampered webhook events. The SDK also provides TypeScript types for all Mux webhook event types (video.created, live_stream.started, etc.), enabling type-safe event handling in webhook handlers.

Exposes Mux API capabilities as dynamically generated MCP tools that can be called by AI assistants and LLM agents. The MCP server (@mux/mcp package) wraps the underlying Mux SDK and generates tool definitions (name, description, input schema) for each API operation, allowing Claude or other MCP-compatible clients to discover and invoke Mux operations conversationally. Tool schemas are generated from the SDK's TypeScript types, ensuring consistency between SDK and MCP interfaces. The server handles authentication, error translation, and response formatting automatically.

Provides MCP tools for executing arbitrary code snippets in a sandboxed environment and searching Mux SDK documentation. The code execution tool allows AI assistants to test SDK usage patterns, debug integration issues, and generate example code. The documentation search tool enables semantic search over Mux SDK docs and API reference, allowing AI assistants to retrieve relevant documentation snippets to answer user questions or provide code examples. Both tools are exposed as MCP tools that can be invoked by Claude or other MCP clients.

Supports multiple transport protocols for MCP server deployment, including stdio (for local Claude integration), HTTP (for remote access), and SSE (Server-Sent Events). The MCP server can be configured to listen on different transports, enabling deployment scenarios ranging from local development (stdio) to cloud-hosted services (HTTP/SSE). Transport selection is configured at server startup through environment variables or configuration files, allowing the same MCP server code to be deployed across different environments without code changes.

Provides runtime abstraction shims that enable the Mux SDK to run across multiple JavaScript runtimes (Node.js, Deno, Bun, browsers, Cloudflare Workers) without code changes. The SDK detects the runtime environment at initialization and loads appropriate polyfills or native implementations for HTTP clients, crypto operations, and file system access. This allows developers to use the same SDK code in Node.js backends, Deno scripts, browser applications, and serverless functions without maintaining separate implementations.

Provides strongly-typed TypeScript abstractions over Mux's REST API endpoints through resource classes that extend a base APIResource class. Each resource (Assets, LiveStreams, Uploads, etc.) exposes CRUD methods (create, retrieve, list, update, delete) that are mapped to underlying HTTP verbs (POST, GET, PUT, PATCH, DELETE) via the APIClient. TypeScript interfaces define request and response shapes, enabling compile-time type checking and IDE autocomplete. The SDK automatically handles request serialization, response deserialization, and error handling for all API operations.