API Reference

Stream

Live Inputs

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Outputs

List all outputs associated with a specified live input

client.stream.liveInputs.outputs.list(stringliveInputIdentifier, OutputListParams { account_id } params, RequestOptionsoptions?): SinglePage<Output { enabled, streamKey, uid, url } >

GET/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs

Create a new output, connected to a live input

client.stream.liveInputs.outputs.create(stringliveInputIdentifier, OutputCreateParams { account_id, streamKey, url, enabled } params, RequestOptionsoptions?): Output { enabled, streamKey, uid, url }

POST/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs

Update an output

client.stream.liveInputs.outputs.update(stringliveInputIdentifier, stringoutputIdentifier, OutputUpdateParams { account_id, enabled } params, RequestOptionsoptions?): Output { enabled, streamKey, uid, url }

PUT/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}

Delete an output

client.stream.liveInputs.outputs.delete(stringliveInputIdentifier, stringoutputIdentifier, OutputDeleteParams { account_id } params, RequestOptionsoptions?): void

DELETE/accounts/{account_id}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}

ModelsExpand Collapse

Output { enabled, streamKey, uid, url }

enabled?: boolean

When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.

streamKey?: string

The streamKey used to authenticate against an output’s target.

uid?: string

A unique identifier for the output.

maxLength32

url?: string

The URL an output uses to restream.