Skip to Content
Mux Docs: Home
Create a new Web Input
post

Create a new Web Input

Request body params
id
string

Unique identifier for the Web Input.

created_at
string

Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).

url
string

The URL for the Web Input to load.

auto_launch
boolean

When set to true the Web Input will automatically launch and start streaming immediately after creation

live_stream_id
string

The Live Stream ID to broadcast this Web Input to

status
string
Possible values: "idle""launching""streaming"
passthrough
string

Arbitrary metadata that will be included in the Web Input details and related webhooks. Can be used to store your own ID for the Web Input. Max: 255 characters.

resolution
string
(default: 1920x1080)
Possible values: "1920x1080""1280x720""1080x1920""720x1280""1080x1080""720x720"

The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set.

timeout
integer
(default: 3600)

The number of seconds that the Web Input should stream for before automatically shutting down.

post
201
/video/v1/web-inputs
Request
(application/json)
{
  "url": "https://example.com/hello.html",
  "live_stream_id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag"
}
Response
(application/json)
{
  "data": {
    "id": "S3Jlx7KABs1EfhscCGEM02G5RYpgwb02nn",
    "created_at": "1609868768",
    "url": "https://example.com/hello.html",
    "live_stream_id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "status": "idle",
    "resolution": "1920x1080",
    "timeout": 3600
  }
}