How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mux Live Streams API

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).

Mux Live Streams API is one of 38 APIs that Mux publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Live Streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 22 operations across 15 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 4 base URLs: https://api.mux.com, https://image.mux.com, https://stream.mux.com, https://stats.mux.com.

22 operations 15 paths 29 schemas 4 DELETE6 GET1 PATCH5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.mux.com
Authentication
HTTP Basic, HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Mux Live Streams API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP basic authentication (accessToken). It accepts HTTP bearer tokens (authorizationToken).

  • basicAuth — HTTP Basic auth using a Mux Access Token ID (username) and Secret (password).
  • accessToken — The Mux Video API uses an Access Token and Secret Key for authentication. If you haven't already, [generate a new Access Token](https://dashboard.mux.com/setti…
  • authorizationToken — OAuth authorization token, used as a Bearer Auth header

Paths & Operations 22

Across 15 paths, the API surfaces 22 operations — 4 DELETE, 6 GET, 1 PATCH, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Live Streams 22

Create and manage live streams.

GET
/video/v1/live_streams
List live streams
listLiveStreams → 200
POST
/video/v1/live_streams
Create a live stream
createLiveStream body → 201
GET
/video/v1/live_streams/{LIVE_STREAM_ID}
Retrieve a live stream
getLiveStream 1 param → 200
POST
/video/v1/live-streams
Create a Live Stream
create-live-stream body → 201
GET
/video/v1/live-streams
List Live Streams
list-live-streams 4 params → 200
GET
/video/v1/live-streams/{LIVE_STREAM_ID}
Retrieve a Live Stream
get-live-stream 1 param → 200
DELETE
/video/v1/live-streams/{LIVE_STREAM_ID}
Delete a Live Stream
delete-live-stream 1 param → 204
PATCH
/video/v1/live-streams/{LIVE_STREAM_ID}
Update a Live Stream
update-live-stream 1 param body → 200
POST
/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids
Create a Live Stream Playback ID
create-live-stream-playback-id 1 param body → 201
GET
/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}
Retrieve a Live Stream Playback ID
get-live-stream-playback-id 2 params → 200
DELETE
/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}
Delete a Live Stream Playback ID
delete-live-stream-playback-id 2 params → 204
POST
/video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key
Reset a Live Stream's Stream Key
reset-stream-key 1 param → 201
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/complete
Signal a Live Stream Is Finished
signal-live-stream-complete 1 param → 200
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/disable
Disable a Live Stream
disable-live-stream 1 param → 200
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/enable
Enable a Live Stream
enable-live-stream 1 param → 200
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles
Update a Live Stream's Embedded Subtitles
update-live-stream-embedded-subtitles 1 param body → 200
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/generated-subtitles
Update a Live Stream's Generated Subtitles
update-live-stream-generated-subtitles 1 param body → 200
POST
/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets
Create a Live Stream Simulcast Target
create-live-stream-simulcast-target 1 param body → 201
DELETE
/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}
Delete a Live Stream Simulcast Target
delete-live-stream-simulcast-target 2 params → 204
GET
/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets/{SIMULCAST_TARGET_ID}
Retrieve a Live Stream Simulcast Target
get-live-stream-simulcast-target 2 params → 200
PUT
/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions
Update Live Stream Static Renditions for New Assets
update-live-stream-new-asset-settings-static-renditions 1 param body → 200
DELETE
/video/v1/live-streams/{LIVE_STREAM_ID}/new-asset-settings/static-renditions
Delete a Live Stream's Static Renditions Setting for New Assets
delete-live-stream-new-asset-settings-static-renditions 1 param → 204

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are LiveStream (24 properties), CreateLiveStreamRequest (18 properties), AssetOptions (17 properties), InputSettings (11 properties). Each schema is shown below with its type and property counts.

PlaybackID
object
3 properties 2 required
LiveStreamEmbeddedSubtitleRequest
object
4 properties
LiveStreamStatus
string
idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams…
UpdateLiveStreamRequest
object
8 properties
AssetMetadata
object
Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
3 properties
SimulcastTargetResponse
object
1 property 1 required
CreateStaticRenditionRequest
object
2 properties 1 required
AssetGeneratedSubtitleSettings
object
3 properties
SimulcastTarget
object
6 properties 3 required
UpdateLiveStreamGeneratedSubtitlesRequest
object
1 property
CreatePlaybackIDRequest
object
2 properties
LiveStream
object
24 properties 6 required
UpdateLiveStreamNewAssetSettings
object
Updates the new asset settings to use to generate a new asset for this live stream. Only the mp4support, masteraccess, and videoquality settings may be updated.
4 properties
PlaybackPolicy
string
public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACKID} signed playback IDs should be used with tokens https://…
LiveStreamEmbeddedSubtitleSettings
object
4 properties 3 required
CreateLiveStreamRequest
object
18 properties
ListLiveStreamsResponse
object
1 property 1 required
CreatePlaybackIDResponse
object
1 property 1 required
UpdateLiveStreamEmbeddedSubtitlesRequest
object
1 property
CreateSimulcastTargetRequest
object
3 properties 1 required
InputSettings
object
An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one inp…
11 properties
UpdateLiveStreamNewAssetSettingsStaticRenditionsRequest
object
1 property 1 required
GetLiveStreamPlaybackIDResponse
object
1 property 1 required
LiveStreamGeneratedSubtitleRequest
object
4 properties
LiveStreamMetadata
object
Customer provided metadata about this live stream. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive informat…
1 property
MaxContinuousDuration
integer
The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.
LiveStreamGeneratedSubtitleSettings
object
4 properties 2 required
AssetOptions
object
17 properties
LiveStreamResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mux-com-live-streams-api-openapi.yml Raw ↑

Other APIs Mux publishes across the network.

Mux Webhooks
Mux Animated Images API
Mux Annotations API
Mux Ask Questions API
Mux Assets API
Mux Captions and Transcripts API
Mux Delivery Usage API
Mux Dimensions API
Mux Direct Uploads API
Mux DRM Configurations API
Mux Edit Captions API
Mux Errors API
Where this information came from

This is an independent, third-party profile of Mux Live Streams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.