Mux TypeScript API Library

This library provides convenient access to the Mux REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on docs.mux.com. The full API of this library can be found in api.md.

Note: As of v14 of mux-node-sdk, we have changed some internal workings of the SDKs. You can read more about this here.

MCP Server

Use the Mux MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.

Note: You may need to set environment variables in your MCP client.

Installation

npm install @mux/ts

Usage

The full API of this library can be found in api.md.

import Mux from '@mux/ts';

const client = new Mux({
  tokenId: process.env['MUX_TOKEN_ID'], // This is the default and can be omitted
  tokenSecret: process.env['MUX_TOKEN_SECRET'], // This is the default and can be omitted
});

const asset = await client.video.assets.create({
  inputs: [{ url: 'https://storage.googleapis.com/muxdemofiles/mux-video-intro.mp4' }],
  playback_policies: ['public'],
});

console.log(asset.id);

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import Mux from '@mux/ts';

const client = new Mux({
  tokenId: process.env['MUX_TOKEN_ID'], // This is the default and can be omitted
  tokenSecret: process.env['MUX_TOKEN_SECRET'], // This is the default and can be omitted
});

const params: Mux.Video.AssetCreateParams = {
  inputs: [{ url: 'https://storage.googleapis.com/muxdemo

... [View full README on GitHub](https://github.com/muxinc/mux-node-sdk#readme)