llms.txt
Compare with other sites' llms.txt files →# Mux Documentation for LLMs
> Mux is how developers build online video. Mux provides a complete video platform that includes:
> - Video hosting, encoding, and streaming infrastructure
> - A modern, responsive video player with adaptive controls
> - Video analytics and performance monitoring
> - Mux Robots: managed AI video workflows, including moderation, summaries, chapters, captions, and localization. See the [full workflow catalog](/docs/guides/robots.md#what-you-can-do).
> - all with a great developer experience and surprisingly affordable pricing
## Quick start: What are you trying to do?
- **Find a prompt for a video use case** → Check /docs/prompts.md, match the user's intended outcome, and fetch the relevant prompt for its questions and instructions
- **Build a podcast clipping workflow** → /docs/prompts/podcast-clips.md for application building, one-off processing, or recurring runs
- **Put video behind a paywall** → /docs/prompts/video-paywall.md for signed playback, entitlement-checked tokens, migrating public videos, and DRM
- **Estimate video costs** → Start with /pricing.md, then /docs/pricing/estimating-video-costs.md for usage inputs and assumptions, and /docs/pricing/overview.md for public rates, credits, and custom contract pricing
- **Upload and stream a video file** → Start with /docs/core.txt, then /docs/guides/video.txt
- **Analyze or enrich a video with AI** → /docs/guides/robots.txt for Mux Robots workflows and prerequisites, then /docs/api-reference/robots.txt for the v1 API
- **Automate AI workflows on new uploads** → /docs/guides/robots-directives.md for Directives
- **Migrate from the Robots Beta (v0) API** → /docs/guides/robots-migrate-to-v1.md, plus /docs/guides/robots-migrate-typescript-sdk-to-v1.md for @mux/ts
- **Build a video player** → /docs/guides/player.txt
- **Handle file uploads from users** → /docs/guides/uploader.txt
- **Track playback metrics and analytics** → /docs/guides/data.txt
- **Set up a live stream** → /docs/core.txt (live streams section) + /docs/guides/video.txt
- **Integrate with a web framework (Next.js, Rails, etc.)** → /docs/integrations.txt
- **Choose an AI approach** → /docs/guides/robots.md#choose-an-ai-approach: Mux Robots for built-in managed jobs, @mux/ai for custom models/prompts/pipelines, or a direct transcript + LLM call for a narrow text-only task where you own orchestration and provider costs
- **Need the full API reference** → /api-spec.json (its /robots/v0 paths are the deprecated Beta; use /docs/api-reference/robots.txt for Robots)
## Common mistakes to avoid
- **Never expose Mux API credentials in client-side code.** All API calls must come from a server. Use direct uploads or signed URLs for client-side operations.
- **Don't poll the assets endpoint to check status.** Use webhooks instead. The `video.asset.ready` event tells you when an asset is ready for playback.
- **Don't confuse Asset IDs with Playback IDs.** Asset IDs (used with api.mux.com) are for managing assets. Playback IDs (used with stream.mux.com) are for streaming to viewers.
- **Don't expose stream keys in public code.** Treat stream keys like passwords. Anyone with the key can broadcast to your live stream.
- **Don't hardcode playback URLs.** Playback IDs can change. Store the asset ID and look up playback IDs when needed, or store playback IDs separately.
## For AI agents
When a user describes a video use case, check the prompt library at /docs/prompts.md before designing the workflow. Match the intended outcome and fetch only the relevant prompt. Each prompt includes questions to resolve, available execution methods, and acceptance criteria. Some provide a skill entry point for repeated use; scheduling still requires an execution environment.
If you're an AI agent that can use MCP (Model Context Protocol) tools, the Mux MCP server provides direct API access for video uploads, live streaming, analytics queries, and Mux Robots AI workflows. For Robots, check workflow prerequisites, save the job ID and workflow name, and wait for completion before reading outputs. Use webhooks in production or bounded polling for one-off work.
- Hosted MCP: https://mcp.mux.com
- GitHub: https://github.com/muxinc/mux-ts/tree/main/packages/mcp-server
- Setup guide: /docs/integrations/mcp-server.md
## Notes
- All documentation is automatically generated from the same source as our official documentation
- API specifications include detailed endpoint descriptions, request/response formats, and examples following the OpenAPI specification
- The documentation is regularly updated to reflect the latest features and capabilities
- API version: v1 (stable)
- Player version: @mux/mux-player 3.x, @mux/mux-player-react 3.x
- TypeScript SDK: @mux/ts 16.x, where `client.robots` calls Robots v1
## Guide collections
- [/docs/prompts.md](https://www.mux.com/docs/prompts.md): Prompt library: find a matching video use case and its complete agent instructions
- [/docs/core.txt](https://www.mux.com/docs/core.txt): Core Mux concepts (start here for most projects)
- [/llms-full.txt](https://www.mux.com/llms-full.txt): All Mux docs in one file (if your context window is large enough)
- [/docs/guides/video.txt](https://www.mux.com/docs/guides/video.txt): Upload, encode, and manage video assets
- [/docs/guides/uploader.txt](https://www.mux.com/docs/guides/uploader.txt): Handle user uploads from browsers and mobile apps
- [/docs/guides/robots.txt](https://www.mux.com/docs/guides/robots.txt): Mux Robots workflows, prerequisites, job lifecycle, Directives, and migration guides
- [/docs/guides/player.txt](https://www.mux.com/docs/guides/player.txt): Embed video playback with Mux Player
- [/docs/guides/data.txt](https://www.mux.com/docs/guides/data.txt): Track playback quality and viewer analytics
- [/docs/guides/data-integrations.txt](https://www.mux.com/docs/guides/data-integrations.txt): Add Mux Data to third-party players (Video.js, HLS.js, etc.)
- [/docs/integrations.txt](https://www.mux.com/docs/integrations.txt): Framework guides (Next.js, Rails, Laravel, etc.) and SDKs
- [/docs/examples.txt](https://www.mux.com/docs/examples.txt): Example implementations and use cases
- [/pricing.md](https://www.mux.com/pricing.md): Cost-estimation guide: what Mux includes, the usage meters, default assumptions, and starting-at rates
- [/docs/pricing.txt](https://www.mux.com/docs/pricing.txt): Estimate usage first, then look up public rates, credits, and custom contract pricing information
## API references
- [/docs/api-reference/system.txt](https://www.mux.com/docs/api-reference/system.txt): Mux system API specification
- [/docs/api-reference/video.txt](https://www.mux.com/docs/api-reference/video.txt): Mux Video API specification
- [/docs/api-reference/data.txt](https://www.mux.com/docs/api-reference/data.txt): Mux Data API specification
- [/docs/api-reference/robots.txt](https://www.mux.com/docs/api-reference/robots.txt): Mux Robots v1 API specification for jobs, workflows, and Directives
- [/api-spec.json](https://www.mux.com/api-spec.json): Complete Mux API reference
- [/webhook-spec.json](https://www.mux.com/webhook-spec.json): Complete Mux Webhook reference
### External API references
- [https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player/REFERENCE.md](https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player/REFERENCE.md): Mux Player Web Component API reference
- [https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player-react/REFERENCE.md](https://raw.githubusercontent.com/muxinc/elements/refs/heads/main/packages/mux-player-react/REFERENCE.md): Mux Player React Component API reference
## All guides
- [/docs/core/stream-video-files.md](https://www.mux.com/docs/core/stream-video-files.md): Upload a video file to Mux and play it in your application in five minutes or less. Start here when you add video on demand, for example a course platform or user uploads.
- [/docs/core/mux-fundamentals.md](https://www.mux.com/docs/core/mux-fundamentals.md): A reference for the core Mux concepts: organizations, environments, assets, playback IDs, live streams, and webhooks. Read this guide when you start with Mux or when you need a quick refresher.
- [/docs/core/ai-agents.md](https://www.mux.com/docs/core/ai-agents.md): A reference for LLMs and AI coding agents that write code against the Mux API. Read this page first to get correct patterns for assets, uploads, Robots AI workflows, playback, and webhooks.
- [/docs/core/make-api-requests.md](https://www.mux.com/docs/core/make-api-requests.md): This guide shows how to authenticate requests to the Mux API with an access token. Use it when you set up a server, a serverless function, or a script that calls Mux.
- [/docs/core/sdks.md](https://www.mux.com/docs/core/sdks.md): Mux has official API SDKs for TypeScript (Node.js, Deno, Bun), Python, PHP, Ruby, Elixir, Java, and .NET. Use an SDK to authenticate requests and make typed calls to the Mux API from your server.
- [/docs/core/postman.md](https://www.mux.com/docs/core/postman.md): Explore the Mux API with the official Postman collection. Use this guide when you want to test API requests without code, before you write your integration.
- [/docs/core/listen-for-webhooks.md](https://www.mux.com/docs/core/listen-for-webhooks.md): Mux sends webhooks to your server when events occur, for example when an asset becomes ready or a live stream starts. Use this guide to receive these events in production and in local development.
- [/docs/core/verify-webhook-signatures.md](https://www.mux.com/docs/core/verify-webhook-signatures.md): Verify the signature that Mux includes in each webhook request. Use this guide to make sure that webhook events come from Mux and not from a third party.
- [/docs/core/manage-webhooks.md](https://www.mux.com/docs/core/manage-webhooks.md): Use the Webhooks API to create, list, update, and delete the webhooks for an environment. Use this guide when you configure webhooks from code instead of the Mux Dashboard.
- [/docs/core/content-security-policy.md](https://www.mux.com/docs/core/content-security-policy.md): Configure your Content Security Policy (CSP) so that Mux Video and Mux Data work in your web application. Use this guide when your site sets CSP headers and blocks Mux scripts, media, or beacons.
- [/docs/guides/migrate-from-self-managed.md](https://www.mux.com/docs/guides/migrate-from-self-managed.md): Use this guide when your team moves to Mux from self-managed video infrastructure such as AWS MediaConvert, S3, CloudFront, and FFmpeg. It covers setup, content migration, and pricing.
- [/docs/guides/mux-uploader.md](https://www.mux.com/docs/guides/mux-uploader.md): Mux Uploader is a drop-in component that uploads video files to Mux from your web application. Use it when your users select files or drag and drop them to upload.
- [/docs/guides/uploader-web-core-functionality.md](https://www.mux.com/docs/guides/uploader-web-core-functionality.md): See the features that Mux Uploader includes with no extra configuration, such as chunked uploads, drag and drop, and progress UI. Use this guide to decide what to configure.
- [/docs/guides/uploader-web-integrate-in-your-webapp.md](https://www.mux.com/docs/guides/uploader-web-integrate-in-your-webapp.md): Install Mux Uploader and add a video upload UI to your web application. Use this guide when your users upload video files from the browser to Mux.
- [/docs/guides/uploader-web-customize-look-and-feel.md](https://www.mux.com/docs/guides/uploader-web-customize-look-and-feel.md): Change the style and UI features of Mux Uploader to match your brand. Use this guide when you enable pausing, restyle the drop area, or recolor the progress states.
- [/docs/guides/uploader-web-use-subcomponents-directly.md](https://www.mux.com/docs/guides/uploader-web-use-subcomponents-directly.md): Build a custom upload UI from the subcomponents inside Mux Uploader. Use this approach when the default UI does not fit your design and you need full control.
- [/docs/guides/use-video-quality-levels.md](https://www.mux.com/docs/guides/use-video-quality-levels.md): Choose a video quality level (basic, plus, or premium) when you create an asset. Use quality levels to balance video quality, cost, and platform features for each asset.
- [/docs/guides/stream-videos-in-4k.md](https://www.mux.com/docs/guides/stream-videos-in-4k.md): Ingest, store, and deliver on-demand video in resolutions up to 4K. Use this guide when your content is in 2K or 4K and your viewers watch on large screens.
- [/docs/guides/upload-files-directly.md](https://www.mux.com/docs/guides/upload-files-directly.md): Create authenticated URLs so your users upload video directly to Mux. Use Direct Uploads when clients such as browsers or mobile apps send content without an intermediary server.
- [/docs/guides/upload-video-directly-from-android.md](https://www.mux.com/docs/guides/upload-video-directly-from-android.md): Upload video files to Mux from a native Android app with the Android Upload SDK. Use it when your users record or select videos on their devices and upload them directly.
- [/docs/guides/upload-video-directly-from-ios-or-ipados.md](https://www.mux.com/docs/guides/upload-video-directly-from-ios-or-ipados.md): Upload video files to Mux from an iOS or iPadOS app with the Upload SDK and Direct Uploads. Use it when your users upload large videos that need pause, resume, and progress.
- [/docs/guides/minimize-processing-time.md](https://www.mux.com/docs/guides/minimize-processing-time.md): Prepare your video files so Mux can process them faster. Use this guide when you control the encoding pipeline and want your videos ready to stream sooner.
- [/docs/guides/control-recording-resolution.md](https://www.mux.com/docs/guides/control-recording-resolution.md): Set a maximum resolution when your app records video. Use this guide when you build a recording app and want to cut encoding cost and upload time.
- [/docs/guides/play-your-videos.md](https://www.mux.com/docs/guides/play-your-videos.md): Play Mux video in your application with a playback ID and an HLS URL. Use this guide when you play an asset or a live stream in any player, on web or mobile.
- [/docs/guides/playback-videojs-with-mux.md](https://www.mux.com/docs/guides/playback-videojs-with-mux.md): Add a video player to your web app with Video.js, and set it up for signed playback, DRM, Mux Data, casting, live streams and a custom UI.
- [/docs/guides/mux-player-ios.md](https://www.mux.com/docs/guides/mux-player-ios.md): Play Mux video in your iOS or iPadOS app with the Mux Player SDK for Swift. This guide shows how to stream to AVPlayer, monitor playback, and download assets for offline playback.
- [/docs/guides/player-releases-ios.md](https://www.mux.com/docs/guides/player-releases-ios.md): Read the release notes for every version of Mux Player for iOS.
- [/docs/guides/mux-player-android.md](https://www.mux.com/docs/guides/mux-player-android.md): The Mux Player SDK for Android extends media3 to play Mux video in native Android apps. Use this guide to install the SDK, play an asset, and secure playback.
- [/docs/guides/player-releases-android.md](https://www.mux.com/docs/guides/player-releases-android.md): Read the release notes for every version of Mux Player for Android.
- [/docs/guides/mux-background-video.md](https://www.mux.com/docs/guides/mux-background-video.md): Add a muted background video to your web application with the Mux Background Video component. Use it for hero sections and decorative video that plays behind your content.
- [/docs/guides/control-playback-resolution.md](https://www.mux.com/docs/guides/control-playback-resolution.md): Set the resolutions that Mux delivers to the video player. Use playback modifiers to lower delivery cost, save bandwidth, or offer quality tiers to your viewers.
- [/docs/guides/web-autoplay-your-videos.md](https://www.mux.com/docs/guides/web-autoplay-your-videos.md): Understand how browsers control autoplay and how to make autoplay work for your videos. Use this guide when your web application autoplays muted video or background video.
- [/docs/guides/use-a-custom-domain-for-streaming.md](https://www.mux.com/docs/guides/use-a-custom-domain-for-streaming.md): Serve video, images, and live ingest from your own domain instead of mux.com. Use a custom domain for brand consistency or when firewalls or ad blockers block mux.com URLs.
- [/docs/guides/embed-videos-for-social-media.md](https://www.mux.com/docs/guides/embed-videos-for-social-media.md): Add Open Graph meta tags so your videos show as cards on social media. Use this guide when you share pages with video on sites like Facebook or Twitter.
- [/docs/guides/enable-static-mp4-renditions.md](https://www.mux.com/docs/guides/enable-static-mp4-renditions.md): Create MP4 and M4A files from your assets with static renditions. Use these files for offline playback, social media cards, transcription services, and older devices.
- [/docs/guides/download-for-offline-editing.md](https://www.mux.com/docs/guides/download-for-offline-editing.md): Get a temporary URL to download the master version of an asset as an MP4 file. Use master access when you edit, archive, or move a video to another service.
- [/docs/guides/get-images-from-a-video.md](https://www.mux.com/docs/guides/get-images-from-a-video.md): Get thumbnails, animated GIFs, and storyboards from a video with `image.mux.com`. Use these images for poster frames, previews, and timeline hover effects.
- [/docs/guides/set-a-default-thumbnail.md](https://www.mux.com/docs/guides/set-a-default-thumbnail.md): Choose which frame Mux returns when a thumbnail is requested without an explicit time. Set `thumbnail_time` on an asset to control the default poster image.
- [/docs/guides/create-timeline-hover-previews.md](https://www.mux.com/docs/guides/create-timeline-hover-previews.md): Add storyboard images to your player to show previews when a viewer hovers over the timeline. Use hover previews to make seek, fast-forward, and rewind more visual.
- [/docs/guides/playback-legacy-videojs-with-mux.md](https://www.mux.com/docs/guides/playback-legacy-videojs-with-mux.md): Play Mux video with `@mux/videojs-kit`, the legacy Video.js 7 build with Mux features included. Use this guide only for existing integrations.
- [/docs/guides/modify-playback-behavior.md](https://www.mux.com/docs/guides/modify-playback-behavior.md): Add playback modifiers to your HLS URLs to change how Mux delivers a stream. Use them to turn on redundant streams or to set a minimum or maximum resolution.
- [/docs/guides/mux-player-web.md](https://www.mux.com/docs/guides/mux-player-web.md): Mux Player is a drop-in component that plays Mux video in your web application. Use it when you want a full player UI without custom player code.
- [/docs/guides/player-core-functionality.md](https://www.mux.com/docs/guides/player-core-functionality.md): See the features that Mux Player includes with no extra configuration, such as Mux Data monitoring, responsive controls, and timeline hover previews. Use this guide to decide what to configure.
- [/docs/guides/player-integrate-in-your-webapp.md](https://www.mux.com/docs/guides/player-integrate-in-your-webapp.md): Install Mux Player and play your first Mux video in a web application. Use this guide when you add video playback to a site built with React or any other framework.
- [/docs/guides/player-customize-look-and-feel.md](https://www.mux.com/docs/guides/player-customize-look-and-feel.md): Change the colors, poster image, and controls of Mux Player to match your brand. Use this guide when the default player style does not fit your application.
- [/docs/guides/player-themes.md](https://www.mux.com/docs/guides/player-themes.md): Apply a theme to change the layout and style of Mux Player. Use themes when you want a different player UI, such as minimal contro