Skip to content
verify mcp Beta VerifyMCP is currently in beta. If you notice any issues, email [email protected] and we’ll put it right.

com.mux/mcp

NPM · @MUX/MCP · 2 COMPONENTS · SCANNED AUG 3

The official MCP Server for the Mux API

+22 this week 62 Trust /100
Trust breakdown (6 categories)

How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score →

Supply Chain Security88
  • No malware found by supply-chain analysis.Pass
  • Only part of the dependency tree could be resolved (141 of 143), so this covers what we could see, not the whole tree.Partial
  • No install/post-install scripts declared.Pass
  • Only part of the dependency tree could be resolved (141 of 143), so this covers what we could see, not the whole tree. View diagnostics → Partial
Provenance & Transparency45
Schema Quality & AI Usability43
  • AI-judged instruction clarity (good).Pass
  • Context-footprint check failed: tool/resource definitions use about 47756 tokens (~487/item across 98 items; 98 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
  • Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management27
  • Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage92
  • 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
  • 76% of tool parameters carry a description.Partial
Capabilities100
  • Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Install

Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.

npm · @mux/mcp

# add to Claude Code
claude mcp add com-mux-mcp -- npx -y @mux/mcp
# add to Codex CLI
codex mcp add com-mux-mcp -- npx -y @mux/mcp
// opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "com-mux-mcp": {
      "type": "local",
      "command": [
        "npx",
        "-y",
        "@mux/mcp"
      ],
      "enabled": true
    }
  }
}
# add to OpenClaw
openclaw mcp add com-mux-mcp --command npx --arg -y --arg @mux/mcp
# ~/.hermes/config.yaml
mcp_servers:
  com-mux-mcp:
    command: "npx"
    args: ["-y", "@mux/mcp"]
// mcp.json
{
  "mcpServers": {
    "com-mux-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@mux/mcp"
      ]
    }
  }
}
Changelog

Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.

  • 2 Aug 26 +57
    • Provenance: unverified → fail security
    • Install scripts: unverified → pass security
    • Known CVEs: unverified → partial security
    • Malware scan: unverified → pass security
    • Stability: Stability not yet verified: not enough scan history yet (needs a 30-day window). security
    • Dependency health: unverified → partial functional
    • Schema quality: unverified → good functional
    • License: unverified → pass functional
    • Maintenance: unverified → pass functional
    • Stability: unverified → 0.23 functional
    • Tool coverage: unverified → 100 functional
    • MCP protocol: unverified → pass functional
    • Licence: Apache-2.0 functional
  • 1 Aug 26 −17
    • We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
  • 31 Jul 26 −2
    • Malware scan: pass → unverified security
    • Tool coverage: unverified → 100 functional
  • 30 Jul 26 −16
    • Tool coverage: 100 → unverified functional
    • First check of Schema quality: unverified functional
  • 27 Jul 26 40

    First indexed and scored.

Diagnostics

Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.

Captured 3 Aug 2026 · Analysed npm/@mux/[email protected]

Provenance none

Ecosystem: npm · Outcome: none

Dependencies 141 packages

141 packages in the resolved dependency tree · 135 deprecated · 39 stale.

The dependency tree was only partially resolved, so these counts may be incomplete.

MCP tools — 98 exposed · ~47,756 tokens

The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.

Tool Tokens
list_monitoring_data_metrics ~283

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists available monitoring metrics. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { display_name: { type: 'string' }, name: { type: 'string' } }, required: [ 'display_name', 'name' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } ```

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

list_related_data_incidents ~1,054

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns all the incidents that seem related to a specific incident. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/incident' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { incident: { type: 'object', properties: { id: { type: 'string' }, affected_views: { type: 'integer' }, affected_views_per_hour: { type: 'integer' }, affected_views_per_hour_on_open: { type: 'integer' }, breakdowns: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, name: { type: 'string' }, value: { type: 'string' } }, required: [ 'id', 'name', 'value' ] } }, description: { type: 'string' }, error_description: { type: 'string' }, impact: { type: 'string' }, incident_key: { type: 'string' }, measured_value: { type: 'number' }, measured_value_on_close: { type: 'number' }, measurement: { type: 'string' }, notification_rules: { type: 'array', items: { type: 'object', properties: { id: {…

NameTypeReqDescription
INCIDENT_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
order_bystringValue to order the results by
order_directionstringSort order.
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_system_signing_keys ~389

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of signing keys. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/signing_key' } } }, required: [ 'data' ], $defs: { signing_key: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Signing Key.' }, created_at: { type: 'string', description: 'Time at which the object was created. Measured in seconds since the Unix epoch.' }, private_key: { type: 'string', description: 'A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.**' } }, required: [ 'id', 'created_at' ] } } } ```

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_trace_elements_data_dimensions ~741

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists the elements (values) for a trace dimension along with their total counts. This endpoint is specifically designed for trace dimensions like video_cdn_trace that contain arrays of values. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/dimension_value' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { dimension_value: { type: 'object', properties: { total_count: { type: 'integer' }, value: { type: 'string' } }, required: [ 'total_count', 'value' ] } } } ```

NameTypeReqDescription
DIMENSION_IDstringyes
filtersarrayFilter results using key:value pairs. Must be provided as an array query string parameter. **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
metric_filtersarrayLimit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as t…
order_bystringValue to order the results by
order_directionstringSort order.
pageintegerOffset by this many pages, of the size of `limit`
timeframearrayTimeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&tim…

No output schema declared.

No examples provided.

list_values_data_dimensions ~707

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists the values for a dimension along with a total count of related views. Note: This API replaces the list-filter-values API call. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/dimension_value' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { dimension_value: { type: 'object', properties: { total_count: { type: 'integer' }, value: { type: 'string' } }, required: [ 'total_count', 'value' ] } } } ```

NameTypeReqDescription
DIMENSION_IDstringyes
filtersarrayFilter results using key:value pairs. Must be provided as an array query string parameter. **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
metric_filtersarrayLimit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter. Possible filterable metrics are the same as t…
pageintegerOffset by this many pages, of the size of `limit`
timeframearrayTimeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&tim…

No output schema declared.

No examples provided.

list_values_data_filters ~612

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/filter_value' } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ], $defs: { filter_value: { type: 'object', properties: { total_count: { type: 'integer' }, value: { type: 'string' } }, required: [ 'total_count', 'value' ] } } } ```

NameTypeReqDescription
FILTER_IDstringyes
filtersarrayFilter results using key:value pairs. Must be provided as an array query string parameter. **Basic filtering:** * `filters[]=dimension:value` - Include rows where dimension equals value * `filters[]…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`
timeframearrayTimeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&tim…

No output schema declared.

No examples provided.

list_video_assets ~125

List all Mux assets.

NameTypeReqDescription
cursorstringThis parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses.
limitintegerNumber of items to include in the response
live_stream_idstringFilter response to return all the assets for this live stream only
pageintegerOffset by this many pages, of the size of `limit`
upload_idstringFilter response to return an asset created from this direct upload only

No output schema declared.

No examples provided.

list_video_delivery_usage ~1,362

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/delivery_report' } }, limit: { type: 'integer', description: 'Number of assets returned in this response. Default value is 100.' }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'limit', 'timeframe', 'total_row_count' ], $defs: { delivery_report: { type: 'object', properties: { asset_duration: { type: 'number', description: 'The duration of the asset in seconds.' }, asset_encoding_tier: { type: 'string', description: 'This field is deprecated. Please use `asset_video_quality` instead. The encoding tier that the asset was ingested at. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels)', enum: [ 'smart', 'baseline', 'premium' ] }, asset_id: { type: 'string', description: 'Unique identifier for the asset.' }, asset_resolution_tier: { type: 'string', description: 'The resolution tier that the asset was ingested at, affecting billing for ingest & storage', enum: [ 'audio-only', '720p', '1080p', '1440p', '2160p' ] }, asset_state: { type: 'string', description: 'The state of the asset.', enum: [ 'ready', 'errored',…

NameTypeReqDescription
asset_idstringFilter response to return delivery usage for this asset only. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
live_stream_idstringFilter response to return delivery usage for assets for this live stream. You cannot specify both the `asset_id` and `live_stream_id` parameters together.
pageintegerOffset by this many pages, of the size of `limit`
timeframearrayTime window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing u…

No output schema declared.

No examples provided.

list_video_drm_configurations ~295

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of DRM Configurations # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/drm_configuration' } } }, required: [ 'data' ], $defs: { drm_configuration: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the DRM Configuration. Max 255 characters.' } }, required: [ 'id' ] } } } ```

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_video_live_streams ~94

Lists the live streams that currently exist in the current environment.

NameTypeReqDescription
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`
statusstringFilter response to return live streams with the specified status only
stream_keystringFilter response to return live stream for this stream key only

No output schema declared.

No examples provided.

list_video_playback_restrictions ~770

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns a list of all Playback Restrictions. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/playback_restriction' } } }, required: [ 'data' ], $defs: { playback_restriction: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Playback Restriction. Max 255 characters.' }, created_at: { type: 'string', description: 'Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).' }, referrer: { type: 'object', description: 'A list of domains allowed to play your videos.', properties: { allow_no_referrer: { type: 'boolean', description: 'A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests.' }, allowed_domains: { type: 'array', description: 'List of domains allowed to play videos. Possible values are\n * `[]` Empty Array indicates deny video playback requests for all domains\n * `["*"]` A Single Wildcard `*` entry means allow video playback requests from any domain\n * `["*.example.com", "foo.com"]` A list of up to 10 domains or valid dns-style wildcards\n', items: { type: 'string' } } } }, updated_at: { type: 'string', description: 'Time the Playback Restriction was last updated, def…

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_video_transcription_vocabularies ~526

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. List all Transcription Vocabularies. # Response Schema ```json { type: 'object', properties: { data: { type: 'array', items: { $ref: '#/$defs/transcription_vocabulary' } } }, $defs: { transcription_vocabulary: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Transcription Vocabulary' }, created_at: { type: 'string', description: 'Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch).' }, updated_at: { type: 'string', description: 'Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch).' }, name: { type: 'string', description: 'The user-supplied name of the Transcription Vocabulary.' }, passthrough: { type: 'string', description: 'Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters.' }, phrases: { type: 'array', description: 'Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream\'s `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted.', items: { type: 'string', description: 'A phrase or word belonging to a Transcription Vocabulary.' } } }, required: [ 'id', 'created_at', 'updated_at' ] } } } ```

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_video_uploads ~52

Lists direct uploads in the current environment.

NameTypeReqDescription
limitintegerNumber of items to include in the response
pageintegerOffset by this many pages, of the size of `limit`

No output schema declared.

No examples provided.

list_video_views_data_exports ~397

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Lists the available video view exports along with URLs to retrieve them. # Response Schema ```json { $ref: '#/$defs/video_view_exports_response', $defs: { video_view_exports_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { export_date: { type: 'string', format: 'date' }, files: { type: 'array', items: { type: 'object', properties: { path: { type: 'string' }, type: { type: 'string' }, version: { type: 'integer' } }, required: [ 'path', 'type', 'version' ] } } }, required: [ 'export_date', 'files' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```

NameTypeReqDescription
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

reset_stream_key_video_live_streams ~53

Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.

NameTypeReqDescription
LIVE_STREAM_IDstringyes

No output schema declared.

No examples provided.

retrieve_breakdown_data_real_time ~584

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. This API is now deprecated, please use the `Get Monitoring Breakdown` API. # Response Schema ```json { $ref: '#/$defs/real_time_breakdown_response', $defs: { real_time_breakdown_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { concurrent_viewers: { type: 'integer' }, metric_value: { type: 'number' }, negative_impact: { type: 'integer' }, starting_up_viewers: { type: 'integer' }, value: { type: 'string' }, display_value: { type: 'string' } }, required: [ 'concurrent_viewers', 'metric_value', 'negative_impact', 'starting_up_viewers', 'value' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```

NameTypeReqDescription
REALTIME_METRIC_IDstringyes
dimensionstringDimension the specified value belongs to
filtersarrayLimit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` char…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
order_bystringValue to order the results by
order_directionstringSort order.
timestampintegerTimestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.

No output schema declared.

No examples provided.

retrieve_data_annotations ~348

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns the details of a specific annotation. # Response Schema ```json { $ref: '#/$defs/annotation_response', $defs: { annotation_response: { type: 'object', properties: { data: { $ref: '#/$defs/annotation' } }, required: [ 'data' ] }, annotation: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the annotation' }, date: { type: 'string', description: 'Datetime when the annotation applies', format: 'date-time' }, note: { type: 'string', description: 'The annotation note content' }, sub_property_id: { type: 'string', description: 'Customer-defined sub-property identifier' } }, required: [ 'id', 'date', 'note' ] } } } ```

NameTypeReqDescription
ANNOTATION_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_data_incidents ~996

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Returns the details of an incident. # Response Schema ```json { $ref: '#/$defs/incident_response', $defs: { incident_response: { type: 'object', properties: { data: { $ref: '#/$defs/incident' }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] }, incident: { type: 'object', properties: { id: { type: 'string' }, affected_views: { type: 'integer' }, affected_views_per_hour: { type: 'integer' }, affected_views_per_hour_on_open: { type: 'integer' }, breakdowns: { type: 'array', items: { type: 'object', properties: { id: { type: 'string' }, name: { type: 'string' }, value: { type: 'string' } }, required: [ 'id', 'name', 'value' ] } }, description: { type: 'string' }, error_description: { type: 'string' }, impact: { type: 'string' }, incident_key: { type: 'string' }, measured_value: { type: 'number' }, measured_value_on_close: { type: 'number' }, measurement: { type: 'string' }, notification_rules: { type: 'array', items: { type…

NameTypeReqDescription
INCIDENT_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_data_video_views ~27

Returns the details of a video view.

NameTypeReqDescription
VIDEO_VIEW_IDstringyes

No output schema declared.

No examples provided.

retrieve_histogram_timeseries_data_real_time ~702

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the `Get Monitoring Histogram Timeseries` API. # Response Schema ```json { $ref: '#/$defs/real_time_histogram_timeseries_response', $defs: { real_time_histogram_timeseries_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { average: { type: 'number' }, bucket_values: { type: 'array', items: { type: 'object', properties: { count: { type: 'integer' }, percentage: { type: 'number' } }, required: [ 'count', 'percentage' ] } }, max_percentage: { type: 'number' }, median: { type: 'number' }, p95: { type: 'number' }, sum: { type: 'integer' }, timestamp: { type: 'string' } }, required: [ 'average', 'bucket_values', 'max_percentage', 'median', 'p95', 'sum', 'timestamp' ] } }, meta: { type: 'object', properties: { bucket_unit: { type: 'string' }, buckets: { type: 'array',…

NameTypeReqDescription
REALTIME_HISTOGRAM_METRIC_IDstringyes
filtersarrayLimit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` char…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_input_info_video_assets ~45

Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input.

NameTypeReqDescription
ASSET_IDstringyes

No output schema declared.

No examples provided.

retrieve_playback_id_video_assets ~488

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves information about the specified playback ID. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/playback_id' } }, required: [ 'data' ], $defs: { playback_id: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the PlaybackID' }, policy: { $ref: '#/$defs/playback_policy' }, drm_configuration_id: { type: 'string', description: 'The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.' } }, required: [ 'id', 'policy' ] }, playback_policy: { type: 'string', description: '* `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}`\n\n* `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens.\n\n* `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).', enum: [ 'public', 'signed', 'drm' ] } } } ```

NameTypeReqDescription
ASSET_IDstringyes
PLAYBACK_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_playback_id_video_live_streams ~506

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/playback_id' } }, required: [ 'data' ], $defs: { playback_id: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the PlaybackID' }, policy: { $ref: '#/$defs/playback_policy' }, drm_configuration_id: { type: 'string', description: 'The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.' } }, required: [ 'id', 'policy' ] }, playback_policy: { type: 'string', description: '* `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}`\n\n* `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens.\n\n* `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).', enum: [ 'public', 'signed', 'drm' ] } } } ```

NameTypeReqDescription
LIVE_STREAM_IDstringyes
PLAYBACK_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_simulcast_target_video_live_streams ~905

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/simulcast_target' } }, required: [ 'data' ], $defs: { simulcast_target: { type: 'object', properties: { id: { type: 'string', description: 'ID of the Simulcast Target' }, status: { type: 'string', description: 'The current status of the simulcast target. See Statuses below for detailed description.\n * `idle`: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.\n * `starting`: The simulcast target transitions into this state when the parent live stream transition into connected state.\n * `broadcasting`: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.\n * `errored`: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. When a simulcast target has this status it will have an `error_severity` field with more details about the error.', enum: [ 'idle', 'starting', 'broadcasting', 'errored' ] }, url: { type: 'string', description: 'The RTMP(s) or SRT endpoint for a simulcast destination.\n* For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: `rtmp://live.example.com/app`.…

NameTypeReqDescription
LIVE_STREAM_IDstringyes
SIMULCAST_TARGET_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_system_signing_keys ~420

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves the details of a signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.** # Response Schema ```json { $ref: '#/$defs/signing_key_response', $defs: { signing_key_response: { type: 'object', properties: { data: { $ref: '#/$defs/signing_key' } }, required: [ 'data' ] }, signing_key: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Signing Key.' }, created_at: { type: 'string', description: 'Time at which the object was created. Measured in seconds since the Unix epoch.' }, private_key: { type: 'string', description: 'A Base64 encoded private key that can be used with the RS256 algorithm when creating a [JWT](https://jwt.io/). **Note that this value is only returned once when creating a URL signing key.**' } }, required: [ 'id', 'created_at' ] } } } ```

NameTypeReqDescription
SIGNING_KEY_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_timeseries_data_real_time ~492

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Gets Time series information for a specific metric along with the number of concurrent viewers. This API is now deprecated, please use the `Get Monitoring Timeseries` API. # Response Schema ```json { $ref: '#/$defs/real_time_timeseries_response', $defs: { real_time_timeseries_response: { type: 'object', properties: { data: { type: 'array', items: { type: 'object', properties: { concurrent_viewers: { type: 'integer' }, date: { type: 'string' }, value: { type: 'number' } }, required: [ 'concurrent_viewers', 'date', 'value' ] } }, timeframe: { type: 'array', items: { type: 'integer' } }, total_row_count: { type: 'integer' } }, required: [ 'data', 'timeframe', 'total_row_count' ] } } } ```

NameTypeReqDescription
REALTIME_METRIC_IDstringyes
filtersarrayLimit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` char…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
timestampintegerTimestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.

No output schema declared.

No examples provided.

retrieve_video_assets ~63

Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.

NameTypeReqDescription
ASSET_IDstringyes

No output schema declared.

No examples provided.

retrieve_video_drm_configurations ~257

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves a single DRM Configuration. # Response Schema ```json { type: 'object', properties: { data: { $ref: '#/$defs/drm_configuration' } }, required: [ 'data' ], $defs: { drm_configuration: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the DRM Configuration. Max 255 characters.' } }, required: [ 'id' ] } } } ```

NameTypeReqDescription
DRM_CONFIGURATION_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_video_live_streams ~69

Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.

NameTypeReqDescription
LIVE_STREAM_IDstringyes

No output schema declared.

No examples provided.

retrieve_video_playback_ids ~550

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID. # Response Schema ```json { type: 'object', properties: { data: { type: 'object', properties: { id: { type: 'string', description: 'The Playback ID used to retrieve the corresponding asset or the live stream ID' }, object: { type: 'object', description: 'Describes the Asset or LiveStream object associated with the playback ID.', properties: { id: { type: 'string', description: 'The identifier of the object.' }, type: { type: 'string', description: 'Identifies the object type associated with the playback ID.', enum: [ 'asset', 'live_stream' ] } }, required: [ 'id', 'type' ] }, policy: { $ref: '#/$defs/playback_policy' } }, required: [ 'id', 'object', 'policy' ] } }, required: [ 'data' ], $defs: { playback_policy: { type: 'string', description: '* `public` playback IDs are accessible by constructing an HLS URL like `https://stream.mux.com/${PLAYBACK_ID}`\n\n* `signed` playback IDs should be used with tokens `https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}`. See [Secure video playback](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens.\n\n* `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm).', enum: [ 'public', 'signed', 'drm' ] } } } ```

NameTypeReqDescription
PLAYBACK_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_video_playback_restrictions ~765

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves a Playback Restriction associated with the unique identifier. # Response Schema ```json { $ref: '#/$defs/playback_restriction_response', $defs: { playback_restriction_response: { type: 'object', properties: { data: { $ref: '#/$defs/playback_restriction' } }, required: [ 'data' ] }, playback_restriction: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Playback Restriction. Max 255 characters.' }, created_at: { type: 'string', description: 'Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).' }, referrer: { type: 'object', description: 'A list of domains allowed to play your videos.', properties: { allow_no_referrer: { type: 'boolean', description: 'A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests.' }, allowed_domains: { type: 'array', description: 'List of domains allowed to play videos. Possible values are\n * `[]` Empty Array indicates deny video playback requests for all domains\n * `["*"]` A Single Wildcard `*` entry means allow video playback requests from any domain\n * `["*.example.com", "foo.com"]` A list of up to 10 domains or valid dns-style wildcards\n', items: { type: 'string' } } } }, update…

NameTypeReqDescription
PLAYBACK_RESTRICTION_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_video_transcription_vocabularies ~563

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Retrieves the details of a Transcription Vocabulary that has previously been created. Supply the unique Transcription Vocabulary ID and Mux will return the corresponding Transcription Vocabulary information. The same information is returned when creating a Transcription Vocabulary. # Response Schema ```json { $ref: '#/$defs/transcription_vocabulary_response', $defs: { transcription_vocabulary_response: { type: 'object', properties: { data: { $ref: '#/$defs/transcription_vocabulary' } }, required: [ 'data' ] }, transcription_vocabulary: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Transcription Vocabulary' }, created_at: { type: 'string', description: 'Time the Transcription Vocabulary was created, defined as a Unix timestamp (seconds since epoch).' }, updated_at: { type: 'string', description: 'Time the Transcription Vocabulary was updated, defined as a Unix timestamp (seconds since epoch).' }, name: { type: 'string', description: 'The user-supplied name of the Transcription Vocabulary.' }, passthrough: { type: 'string', description: 'Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters.' }, phrases: { type: 'array', description: 'Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream\'s `generated_subtitles` configuration, the probability of successful speech recognition for these words or phrases is boosted.', items: {…

NameTypeReqDescription
TRANSCRIPTION_VOCABULARY_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

retrieve_video_uploads ~32

Fetches information about a single direct upload in the current environment.

NameTypeReqDescription
UPLOAD_IDstringyes

No output schema declared.

No examples provided.

static_rendition_video_playback ~118

Fetch a static rendition (usually an MP4 or M4A file) of the specified video asset. [MP4 Support](https://docs.mux.com/guides/enable-static-mp4-renditions) must be enabled on the asset before using these URLs.

NameTypeReqDescription
FILENAMEstringyes
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).

No output schema declared.

No examples provided.

storyboard_meta_video_playback ~488

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Fetch metadata for the [storyboard image in JSON format](https://docs.mux.com/guides/create-timeline-hover-previews#json), detailing the coordinates and time ranges of each thumbnail. # Response Schema ```json { type: 'string' } ```

NameTypeReqDescription
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
asset_end_timenumberSet the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
asset_start_timenumberSet the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
formatstringThe format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
program_end_timeintegerSet the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch inte…
program_start_timeintegerSet the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch in…

No output schema declared.

No examples provided.

storyboard_video_playback ~319

Fetch a storyboard image composed of multiple thumbnails for use in [timeline hover previews](https://docs.mux.com/guides/create-timeline-hover-previews).

NameTypeReqDescription
EXTENSIONstringyes
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
asset_end_timenumberSet the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
asset_start_timenumberSet the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
program_end_timeintegerSet the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch inte…
program_start_timeintegerSet the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch in…

No output schema declared.

No examples provided.

storyboard_vtt_video_playback ~457

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Fetch metadata for the [storyboard image in WebVTT format](https://docs.mux.com/guides/create-timeline-hover-previews#webvtt), detailing the coordinates and time ranges of each thumbnail. # Response Schema ```json { type: 'string' } ```

NameTypeReqDescription
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
asset_end_timenumberSet the relative end time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
asset_start_timenumberSet the relative start time of the asset (in seconds) when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips).
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
program_end_timeintegerSet the end time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch inte…
program_start_timeintegerSet the start time of the asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as an epoch in…

No output schema declared.

No examples provided.

thumbnail_video_playback ~390

[Fetch a thumbnail image from a video](https://docs.mux.com/guides/get-images-from-a-video) at a specified time with optional transformations.

NameTypeReqDescription
EXTENSIONstringyes
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
fit_modestringHow to fit a thumbnail within the specified width + height.
flip_hbooleanFlip the image left-right after performing all other transformations.
flip_vbooleanFlip the image top-bottom after performing all other transformations.
heightintegerThe height of the thumbnail (in pixels). Defaults to the height of the original video.
latestbooleanWhen set to `true`, pulls the latest thumbnail from the playback ID of an ongoing live stream. Can only be used with live streams. Can be used to build moderation and classification workflows, [see d…
program_timeintegerSet the time of the thumbnail for an asset created from a live stream when using the [instant clipping feature](https://docs.mux.com/guides/create-instant-clips). The timestamp should be provided as…
rotatestringRotate the image clockwise by the given number of degrees.
timenumberThe time (in seconds) of the video timeline where the image should be pulled. Defaults to the middle of the original video.
widthintegerThe width of the thumbnail (in pixels). Defaults to the width of the original video.

No output schema declared.

No examples provided.

track_video_playback ~206

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Fetch a standalone WebVTT version of a text track from an asset. # Response Schema ```json { type: 'string' } ```

NameTypeReqDescription
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
TRACK_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

transcript_video_playback ~265

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Fetch a [transcript of an asset](https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts#retrieve-a-transcript). This is only possible for assets with a text track generated using the [VOD generated captions feature](https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts). # Response Schema ```json { type: 'string' } ```

NameTypeReqDescription
PLAYBACK_IDstringyes
TOKENstringSigned token (JWT) for [secure video playback](https://docs.mux.com/guides/secure-video-playback).
TRACK_IDstringyes
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

update_data_annotations ~386

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Updates an existing annotation. # Response Schema ```json { $ref: '#/$defs/annotation_response', $defs: { annotation_response: { type: 'object', properties: { data: { $ref: '#/$defs/annotation' } }, required: [ 'data' ] }, annotation: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the annotation' }, date: { type: 'string', description: 'Datetime when the annotation applies', format: 'date-time' }, note: { type: 'string', description: 'The annotation note content' }, sub_property_id: { type: 'string', description: 'Customer-defined sub-property identifier' } }, required: [ 'id', 'date', 'note' ] } } } ```

NameTypeReqDescription
ANNOTATION_IDstringyes
dateintegeryesDatetime when the annotation applies (Unix timestamp)
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…
notestringyesThe annotation note content
sub_property_idstringCustomer-defined sub-property identifier

No output schema declared.

No examples provided.

update_embedded_subtitles_video_live_streams ~74

Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have `closed_captions: true` set.

NameTypeReqDescription
LIVE_STREAM_IDstringyes
embedded_subtitlesarrayDescribe the embedded closed caption contents of the incoming live stream.

No output schema declared.

No examples provided.

update_generated_subtitles_video_live_streams ~82

Updates a live stream's automatic-speech-recognition-generated subtitle configuration. Automatic speech recognition subtitles can be removed by sending an empty array in the request payload.

NameTypeReqDescription
LIVE_STREAM_IDstringyes
generated_subtitlesarrayUpdate automated speech recognition subtitle configuration for a live stream. At most one subtitle track is allowed.

No output schema declared.

No examples provided.

update_master_access_video_assets ~120

Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to "none". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.

NameTypeReqDescription
ASSET_IDstringyes
master_accessstringyesAdd or remove access to the master version of the video.

No output schema declared.

No examples provided.

update_mp4_support_video_assets ~418

This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation). Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated), and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.

NameTypeReqDescription
ASSET_IDstringyes
mp4_supportstringyesSpecify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an…

No output schema declared.

No examples provided.

update_new_asset_settings_static_renditions_video_live_streams ~76

Updates a live stream's static renditions settings for new assets. Further assets made via this live stream will create static renditions per the settings provided. You must provide all static renditions desired.

NameTypeReqDescription
LIVE_STREAM_IDstringyes
static_renditionsarrayyes

No output schema declared.

No examples provided.

update_referrer_video_playback_restrictions ~952

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Allows you to modify the list of domains or change how Mux validates playback requests without the `Referer` HTTP header. The Referrer restriction fully replaces the old list with this new list of domains. # Response Schema ```json { $ref: '#/$defs/playback_restriction_response', $defs: { playback_restriction_response: { type: 'object', properties: { data: { $ref: '#/$defs/playback_restriction' } }, required: [ 'data' ] }, playback_restriction: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Playback Restriction. Max 255 characters.' }, created_at: { type: 'string', description: 'Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).' }, referrer: { type: 'object', description: 'A list of domains allowed to play your videos.', properties: { allow_no_referrer: { type: 'boolean', description: 'A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests.' }, allowed_domains: { type: 'array', description: 'List of domains allowed to play videos. Possible values are\n * `[]` Empty Array indicates deny video playback requests for all domains\n * `["*"]` A Single Wildcard `*` entry means allow video playback requests from any domain\n * `["*.example.com", "foo.com"]` A list of up to 10 domains or valid dns-style w…

NameTypeReqDescription
PLAYBACK_RESTRICTION_IDstringyes
allow_no_referrerbooleanA boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not…
allowed_domainsarrayyesList of domains allowed to play videos. Possible values are * `[]` Empty Array indicates deny video playback requests for all domains * `["*"]` A Single Wildcard `*` entry means allow video playb…
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

update_user_agent_video_playback_restrictions ~869

When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance. Only omit if you're sure you don't need the data. Allows you to modify how Mux validates playback requests with different user agents. Please see [Using User-Agent HTTP header for validation](https://docs.mux.com/guides/secure-video-playback#using-user-agent-http-header-for-validation) for more details on this feature. # Response Schema ```json { $ref: '#/$defs/playback_restriction_response', $defs: { playback_restriction_response: { type: 'object', properties: { data: { $ref: '#/$defs/playback_restriction' } }, required: [ 'data' ] }, playback_restriction: { type: 'object', properties: { id: { type: 'string', description: 'Unique identifier for the Playback Restriction. Max 255 characters.' }, created_at: { type: 'string', description: 'Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).' }, referrer: { type: 'object', description: 'A list of domains allowed to play your videos.', properties: { allow_no_referrer: { type: 'boolean', description: 'A boolean to determine whether to allow or deny HTTP requests without `Referer` HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a `Referer` HTTP header. Set this value to `true` to allow these playback requests.' }, allowed_domains: { type: 'array', description: 'List of domains allowed to play videos. Possible values are\n * `[]` Empty Array indicates deny video playback requests for all domains\n * `["*"]` A Single Wildcard `*` entry means allow video playback requests from any domain\n * `["*.example…

NameTypeReqDescription
PLAYBACK_RESTRICTION_IDstringyes
allow_high_risk_user_agentbooleanyesWhether or not to allow high risk user agents. The high risk user agents are defined by Mux.
allow_no_user_agentbooleanyesWhether or not to allow views without a `User-Agent` HTTP request header.
jq_filterstringA jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field…

No output schema declared.

No examples provided.

update_video_assets ~165

Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the `passthrough` field.

NameTypeReqDescription
ASSET_IDstringyes
metaobjectCustomer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
passthroughstringYou can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can…

No output schema declared.

No examples provided.

update_video_live_streams ~596

Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.

NameTypeReqDescription
LIVE_STREAM_IDstringyes
latency_modestringLatency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.
max_continuous_durationintegerThe time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.
metaobjectCustomer provided metadata about this live stream. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
new_asset_settingsobjectUpdates the new asset settings to use to generate a new asset for this live stream. Only the `mp4_support`, `master_access`, and `video_quality` settings may be updated.
passthroughstringArbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.
reconnect_slate_urlstringThe URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from th…
reconnect_windownumberWhen live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to…
use_slate_for_standard_latencybooleanBy default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard La…

No output schema declared.

No examples provided.