Home
Providers
Mux
Mux
Mux is a video infrastructure platform that gives developers an end-to-end API for ingesting, encoding, storing, delivering, and analyzing video. The platform spans Mux Video (on-demand and live streaming), Mux Data (quality-of-experience analytics), Mux Robots (AI workflows for captions, chapters, summarization, and moderation), and Mux Player (drop-in playback components). Mux exposes a unified REST API at api.mux.com plus delivery hosts at stream.mux.com, image.mux.com, and stats.mux.com, backed by official SDKs in Node, Python, Ruby, PHP, Go, and Elixir, a CLI, and player integrations across web, iOS, Android, Roku, and major HTML5 players.
Mux publishes 35 APIs on the APIs.io network, including Animated Images API, Annotations API, Ask Questions API, and 32 more. Tagged areas include Video Infrastructure, Video Streaming, Live Streaming, Video Analytics, and Video AI.
The Mux catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.
Mux’s developer surface includes authentication, documentation, API reference, getting-started guide, developer console, signup flow, pricing, and 66 more developer resources.
36 APIs
14 Features
7 Use Cases
Video Infrastructure Video Streaming Live Streaming Video Analytics Video AI Encoding
On this page
Kin Score
APIs 36
Postman 1
Open Collections 1
Arazzo 26
Pricing Plans 1
Rate Limits 1
FinOps 1
Features 14
Vocabularies 1
Spectral Rules 1
Security Posture 4
Agentic Access 1
Use Cases 7
Integrations 15
Solutions 5
Resources 73
apis.yml
79 Operational Transparency
Composite quality — 72.9/100 · exemplar
Contract Quality
17.3 / 25
Developer Ergonomics
15.2 / 20
Commercial Clarity
15.8 / 20
Operational Transparency
10.3 / 13
Agent readiness — 44/100 · agent ready
Machine-Readable Contract
18 / 18
Agentic Access Contract
10 / 10
MCP Server
0 / 12
Machine-Readable Auth
10 / 10
Idempotency
0 / 9
Stable Error Semantics
8 / 8
Request/Response Examples
7 / 7
Rate-Limit Signaling
7 / 7
Typed Event Surface
0 / 6
Agent Skills
0 / 5
Well-Known Catalog
0 / 4
Consent & Bot Identity
0 / 3
A2A Agent Card
0 / 8
Dry-Run / Simulate Mode
0 / 4
Individual APIs this provider publishes, each with its own machine-readable definition.
Mux Webhooks deliver signed HTTP callbacks for asset, upload, live stream, and robots job lifecycle events (video.asset.created, video.asset.ready, video.live_stream.active, vid...
APIs for retrieving animated images from videos hosted using Mux.
Annotations allow you to add notes at a specific datetime to view in the Mux Data dashboard.
Ask questions about a video and get structured answers.
An asset refers to a piece of media content that is stored or is being live streamed through the Mux system. An asset always has a duration and one or more tracks (audio, video,...
APIs for retrieving captions and transcripts from videos hosted using Mux that have had captions generated automatically.
The Delivery Usage API allows you to get delivery/streaming usage details for each asset and across all assets. Delivery usage details are aggregated every hour at the top of th...
Dimensions are the types of metadata that can be collected for a video view. Some dimensions are collected automatically based on the playback or device, such as the viewer's Co...
Direct upload allows you to push assets directly to Mux storage instead of needing to go through your own first. When you create a new direct upload, we'll give you back a signe...
DRM Configurations allow you to adjust the security level of content delivered through Mux Video's Digital Rights Management (DRM) feature.
Edit an existing caption track with find-and-replace edits and optional profanity censoring. This workflow is currently in beta.
Playback errors are tracked and aggregated by Mux Data. Errors can be listed by the API, which contains data about the error code, message, and how often the error occurred.
Exports allow you to download the daily CSV files that are generated from the video views that occurred in the previous day. Please contact [support](mailto:support@mux.com) for...
Deprecated, please refer to the Dimensions APIs.
Identify key moments in a video.
Generate chapters for a video.
Incidents occur when an anomaly alert is triggered in Mux Data. The Incidents API provides operations related to the raising and managing of alerting incidents.
List and cancel jobs across all workflows.
A Live Stream represents a unique live stream of video being pushed to Mux. It includes configuration details (a Stream Key) for live broadcasting software/hardware and a Playba...
Historical metrics are used for tracking KPIs, diagnosing issues, and measuring viewers' quality of experience. Metrics are calculated using the video views that have been compl...
Analyze a video for inappropriate content.
Monitoring metrics are used for operational monitoring of a video platform. The metrics are aggregated in five second intervals, across the views that are currently being watche...
Operations related to the manipulation of playback IDs, through which users are able to stream videos and live streams from Mux.
Playback Restrictions allows you to set additional rules for playing videos. You can set the domains/hostnames allowed to play your videos. For instance, viewers can play videos...
The Mux Data Real-time API has been deprecated, please refer to the Mux Data `Monitoring` APIs which provide the same functionality. Mux Data Monitoring metrics are available to...
Signing keys are used to sign JSON Web Tokens (JWTs) for securing certain requests, such as secure playback URLs and access to real-time viewer counts in Mux Data. **One signing...
APIs for retrieving storyboards, sprites, and metadata about the storyboards from videos hosted using Mux.
APIs for streaming video content via HLS and MP4 with customizable playback options.
Generate a title, description, and tags for a video.
APIs for retrieving still thumbnails from videos hosted using Mux.
Transcription Vocabularies allows you to provide collections of phrases like proper nouns, technical jargon, and uncommon words as part of captioning workflows. When using Auto-...
Translate captions from one language to another.
A URL signing key is used as the secret when signing any Mux URL. Mux requires a [JSON Web Token](https://jwt.io/) as the value of the token query parameter. The token query par...
Collection of utility methods for using Mux APIs. There's only one thing in here right now, maybe there will be more later.
An individual video view tracked by Mux Data. For the full list of properties for each view please refer to the table of data fields in the [Export raw video view data guide](ht...
API for retrieving the real-time count of views and viewers based on ID as collected by Mux Data.
Scroll for all 36
Ready-to-run Postman collections for exercising this provider's APIs.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Multi-step API workflows described with the Arazzo specification.
Confirm the active environment with whoami, then list per-asset delivery usage for a timeframe to audit billed delivery.
ARAZZO
Create an asset, wait until ready, queue an AI summarize job against it, then poll the job until it completes.
ARAZZO
Create a Mux Data annotation marking a deploy or event, read it back, update its note, then list annotations to confirm.
ARAZZO
Create an asset, wait until ready, attach a text caption track, then poll the track until it is ready.
ARAZZO
Create an asset, wait until it is ready, then attach a new playback ID and confirm it resolves.
ARAZZO
List assets in the environment, then read the first asset's full detail and its input info.
ARAZZO
Create an asset, wait until ready, request a static MP4 rendition, then poll until the rendition is ready for download.
ARAZZO
Create an asset, wait until ready, attach title and external-id metadata, then delete it to demonstrate full lifecycle management.
ARAZZO
Ingest a video from a hosted URL, poll the new asset until ready, and confirm the input details Mux processed.
ARAZZO
List the available Mux Data dimensions, then enumerate the distinct values of a chosen dimension over a timeframe.
ARAZZO
Create a direct upload URL, poll the upload until Mux creates an asset, then poll the asset until it is ready to play.
ARAZZO
List the playback errors in a timeframe, then read the overall playback-failure rate so errors can be weighed against total traffic.
ARAZZO
List open Mux Data incidents, read the first incident in detail, and pull the incidents related to it.
ARAZZO
Create a live stream, add a second playback ID with a chosen policy, and confirm the playback ID resolves.
ARAZZO
Create a live stream, enable automated speech-recognition subtitles for it, then read it back to confirm the subtitle config.
ARAZZO
Create a live stream, disable it, re-enable it, and signal it complete to walk the operational lifecycle.
ARAZZO
Create a live stream, read it back, add an RTMP simulcast target, and confirm the target is registered.
ARAZZO
Read a metric's overall value for a timeframe, then break it down by a dimension to see which segments drive it.
ARAZZO
Read a metric's overall value for a timeframe, then pull its timeseries to see how the metric trended over time.
ARAZZO
List the available monitoring dimensions, then break a chosen monitoring metric down by a dimension at a timestamp.
ARAZZO
Create a playback restriction, tighten its referrer and user-agent rules, then read it back to confirm the policy.
ARAZZO
List the available real-time metrics and dimensions, then break a chosen real-time metric down by a dimension right now.
ARAZZO
Create a live stream, reset its stream key, and read it back to confirm the new key is in place.
ARAZZO
Create a new system-level signing key for Mux Data SDK auth, read it back, list keys, then delete the previous key.
ARAZZO
Create a new URL signing key, read it back, list all keys, then delete the previous key to complete a rotation.
ARAZZO
List recent video views in a timeframe, then fetch the full detail of the first matching view.
ARAZZO
Scroll for all 26
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Notable capabilities this provider offers.
Scroll for all 14
JSON-LD contexts and semantic vocabularies used across these APIs.
Spectral governance rulesets for linting and validating these APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Recommended x-agentic-access execution contracts for AI agents.
What developers build with this provider.
Scroll for all 7
Pre-built integrations with other platforms and tools.
Scroll for all 15
Packaged solutions this provider offers.
Get Started 3
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 29
Pagination, idempotency, versioning, errors, and events
Scroll for all 29
Build 17
SDKs, sample code, and the tooling you integrate with
Scroll for all 17
Access & Security 6
Authentication, authorization, and security posture
Learn 1
Tutorials, courses, talks, and written guidance
Operate 4
Status, limits, changes, and where to get help
Commercial 5
Pricing, plans, and the legal terms of use
Company 4
The organization behind the API
Source (apis.yml)
aid: mux-com
url: https://raw.githubusercontent.com/api-evangelist/mux-com/refs/heads/main/apis.yml
name: Mux
tags:
- Video Infrastructure
- Video Streaming
- Live Streaming
- Video Analytics
- Video AI
- Encoding
kind: company
accessModel:
pricing: freemium
onboarding: self-serve
trial: false
try_now: true
public: false
label: Freemium · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/mux-com.png
access: 3rd-Party
description: Mux is a video infrastructure platform that gives developers an end-to-end API for ingesting, encoding, storing,
delivering, and analyzing video. The platform spans Mux Video (on-demand and live streaming), Mux Data (quality-of-experience
analytics), Mux Robots (AI workflows for captions, chapters, summarization, and moderation), and Mux Player (drop-in playback
components). Mux exposes a unified REST API at api.mux.com plus delivery hosts at stream.mux.com, image.mux.com, and stats.mux.com,
backed by official SDKs in Node, Python, Ruby, PHP, Go, and Elixir, a CLI, and player integrations across web, iOS, Android,
Roku, and major HTML5 players.
apis:
- aid: mux-com:webhooks
name: Mux Webhooks
tags:
- Webhooks
- Events
- Notifications
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
baseURL: https://api.mux.com
humanURL: https://www.mux.com/docs/webhook-reference
properties:
- url: https://www.mux.com/docs/system/make-api-requests#webhook-security
type: Documentation
- url: https://www.mux.com/docs/webhook-reference
type: APIReference
description: Mux Webhooks deliver signed HTTP callbacks for asset, upload, live stream, and robots job lifecycle events
(video.asset.created, video.asset.ready, video.live_stream.active, video.upload.asset_created, robots.job.completed, and
many more). Each delivery carries a Mux-Signature header (HMAC-SHA256 over the raw body and a per-endpoint secret) and
includes attempt history visible in the dashboard.
- aid: mux-com:mux-com-animated-images-api
name: Mux Animated Images API
description: APIs for retrieving animated images from videos hosted using Mux.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Animated Images
properties:
- type: OpenAPI
url: openapi/mux-com-animated-images-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-annotations-api
name: Mux Annotations API
description: Annotations allow you to add notes at a specific datetime to view in the Mux Data dashboard.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Annotations
properties:
- type: OpenAPI
url: openapi/mux-com-annotations-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-ask-questions-api
name: Mux Ask Questions API
description: Ask questions about a video and get structured answers.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Ask Questions
properties:
- type: OpenAPI
url: openapi/mux-com-ask-questions-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-assets-api
name: Mux Assets API
description: 'An asset refers to a piece of media content that is stored or is being live streamed through the Mux system.
An asset always has a duration and one or more tracks (audio, video, and text data).
The media content of an asset cannot be updated once created, however an asset can be used to create another asset, and
can be modified within that process.'
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Assets
properties:
- type: OpenAPI
url: openapi/mux-com-assets-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-captions-and-transcripts-api
name: Mux Captions and Transcripts API
description: APIs for retrieving captions and transcripts from videos hosted using Mux that have had captions generated
automatically.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Captions and Transcripts
properties:
- type: OpenAPI
url: openapi/mux-com-captions-and-transcripts-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-delivery-usage-api
name: Mux Delivery Usage API
description: 'The Delivery Usage API allows you to get delivery/streaming usage details for each asset and across all assets.
Delivery usage details are aggregated every hour at the top of the hour and can be requested for a specified time window
within the last 90 days starting at 12 hours prior to when the request is made.
Assets are ordered by delivery usage starting with the one with the highest usage. Only assets with delivery usage greater
than 0 seconds are returned in the response.'
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Delivery Usage
properties:
- type: OpenAPI
url: openapi/mux-com-delivery-usage-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-dimensions-api
name: Mux Dimensions API
description: Dimensions are the types of metadata that can be collected for a video view. Some dimensions are collected
automatically based on the playback or device, such as the viewer's Country or the device information. Other dimensions
are specified by the developer when configuring a Mux Data video view such as the video title. The Dimensions APIs allow
you to get a list of the supported dimensions and their values.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Dimensions
properties:
- type: OpenAPI
url: openapi/mux-com-dimensions-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-direct-uploads-api
name: Mux Direct Uploads API
description: 'Direct upload allows you to push assets directly to Mux storage instead of needing to go through your own
first. When you create a new direct upload, we''ll give you back a signed URL for a Google Cloud Storage bucket. Their
storage API is S3 compatible, so whatever tool you use to upload to either GCS or S3 should work, just remember you''re
probably uploading large video files and should [take advantage of things like resumable or multipart uploads](https://cloud.google.com/storage/docs/json_api/v1/how-tos/resumable-upload).
Particularly for customers that deal with a lot of user-generated content, it''s common to expect quite a few abandoned
uploads. To keep those abandoned uploads from cluttering up your asset lists, we don''t create an asset for you until
the upload is complete. Once that asset is created, you can expect all of the normal asset-related webhooks.'
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Direct Uploads
properties:
- type: OpenAPI
url: openapi/mux-com-direct-uploads-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-drm-configurations-api
name: Mux DRM Configurations API
description: DRM Configurations allow you to adjust the security level of content delivered through Mux Video's Digital
Rights Management (DRM) feature.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- DRM Configurations
properties:
- type: OpenAPI
url: openapi/mux-com-drm-configurations-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-edit-captions-api
name: Mux Edit Captions API
description: Edit an existing caption track with find-and-replace edits and optional profanity censoring. This workflow
is currently in beta.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Edit Captions
properties:
- type: OpenAPI
url: openapi/mux-com-edit-captions-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-errors-api
name: Mux Errors API
description: Playback errors are tracked and aggregated by Mux Data. Errors can be listed by the API, which contains data
about the error code, message, and how often the error occurred.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Errors
properties:
- type: OpenAPI
url: openapi/mux-com-errors-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-exports-api
name: Mux Exports API
description: Exports allow you to download the daily CSV files that are generated from the video views that occurred in
the previous day. Please contact [support](mailto:support@mux.com) for information about enabling exports for your organization.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Exports
properties:
- type: OpenAPI
url: openapi/mux-com-exports-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-filters-api
name: Mux Filters API
description: Deprecated, please refer to the Dimensions APIs.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Filters
properties:
- type: OpenAPI
url: openapi/mux-com-filters-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-find-key-moments-api
name: Mux Find Key Moments API
description: Identify key moments in a video.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Find Key Moments
properties:
- type: OpenAPI
url: openapi/mux-com-find-key-moments-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-generate-chapters-api
name: Mux Generate Chapters API
description: Generate chapters for a video.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Generate Chapters
properties:
- type: OpenAPI
url: openapi/mux-com-generate-chapters-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-incidents-api
name: Mux Incidents API
description: Incidents occur when an anomaly alert is triggered in Mux Data. The Incidents API provides operations related
to the raising and managing of alerting incidents.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Incidents
properties:
- type: OpenAPI
url: openapi/mux-com-incidents-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-jobs-api
name: Mux Jobs API
description: List and cancel jobs across all workflows.
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Jobs
properties:
- type: OpenAPI
url: openapi/mux-com-jobs-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: https://www.mux.com/docs/guides/get-images-from-a-video
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Thumbnails
- type: Documentation
url: https://www.mux.com/docs/guides/mux-robots
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Jobs
- type: Documentation
url: https://www.mux.com/docs/guides/signing-jwts
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Signing-Keys
- aid: mux-com:mux-com-live-streams-api
name: Mux Live Streams API
description: 'A Live Stream represents a unique live stream of video being pushed to Mux. It includes configuration details
(a Stream Key) for live broadcasting software/hardware and a Playback ID for playing the stream anywhere. Currently, RTMP
is the only supported method of ingesting video. Use rtmp://global-live.mux.com:5222/app with the Live Stream''s Stream
Key for getting the video into Mux, and use https://stream.mux.com with the Live Stream''s Playback ID for playback.
A Live Stream can be used once for a specific event, or re-used forever. If you''re building an application like Facebook
Live or Twitch, you could create one Live Stream per user. This allows them to configure their broadcasting software once,
and the Live Stream Playback ID will always show their latest stream.
Each RTMP session creates a new video asset automatically. You can set up a webhook to be notified each time a broadcast
(or Live Stream RTMP session) begins or ends with the video.live_stream.active and video.live_stream.idle events respectively.
Assets that are created from a Live Stream have the same behavior as other Assets you create.
Learn more about [how to go live in our guides](https://docs.mux.com/guides/start-live-streaming).'
humanURL: https://www.mux.com/docs/api-reference
baseURL: https://api.mux.com
tags:
- Live Streams
properties:
- type: OpenAPI
url: openapi/mux-com-live-streams-api-openapi.yml
- type: Documentation
url: https://www.mux.com/docs/core/stream-video-files
- type: APIReference
url: https://www.mux.com/docs/api-reference
- type: Documentation
url: https://www.mux.com/docs/guides/start-live-streaming
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Live-Streams
- type: Documentation
url: https://www.mux.com/docs/core/monitor-your-video-streaming-performance
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Video-Views
- type: Documentation
url: https://www.mux.com/docs/guides/play-your-videos
- type: APIReference
url: https://www.mux.com/docs/api-reference#tag/Streaming
- type: Documentation
url: http
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mux-com/refs/heads/main/apis.yml