---
title: "Create a new Web Input"
method: POST
path: "/video/v1/web-inputs"
tags: ["Web Inputs"]
---

# Create a new Web Input

`POST /video/v1/web-inputs`

Create a new Web Input

## Request body

- CreateWebInputRequest
  - `id` string — Unique identifier for the Web Input.
  - `created_at` string, int64 — Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).
  - `url` string, required — 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, required — The Live Stream ID to broadcast this Web Input to
  - `status` '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` '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 — The number of seconds that the Web Input should stream for before automatically shutting down.

## Response `201`

Web Input Created

- WebInputResponse
  - `data` object, required
    - `id` string, required — Unique identifier for the Web Input.
    - `created_at` string, int64, required — Time the Web Input was created, defined as a Unix timestamp (seconds since epoch).
    - `url` string, required — The URL for the Web Input to load.
    - `auto_launch` boolean, required — When set to `true` the Web Input will automatically launch and start streaming immediately after creation
    - `live_stream_id` string, required — The Live Stream ID to broadcast this Web Input to
    - `status` 'idle' | 'launching' | 'streaming', required
    - `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` '1920x1080' | '1280x720' | '1080x1920' | '720x1280' | '1080x1080' | '720x720', required — The resolution of the viewport of the Web Input's browser instance. Defaults to 1920x1080 if not set.
    - `timeout` integer — The number of seconds that the Web Input should stream for before automatically shutting down.

---

[API](https://skmtc.dev/muxinc/apis/mux-api.md) · [All operations](https://skmtc.dev/muxinc/apis/mux-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/muxinc/mux-api/revisions/dcdbbcabe09e/schema)