Web Inputs

Create a new Web Input

Create a new Web Input

post/video/v1/web-inputs

Request body

idstring

Unique identifier for the Web Input.

created_atstring int64

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

urlstring required

The URL for the Web Input to load.

auto_launchboolean

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

live_stream_idstring required

The Live Stream ID to broadcast this Web Input to

status'idle' | 'launching' | 'streaming'
passthroughstring

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'1920x1080' | '1280x720' | '1080x1920' | '720x1280' | '1080x1080' | '720x720'

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

timeoutinteger

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

Response

Web Input Created

Changes