start_live_channel

Start a live channel; optionally block until it reaches Running.

Send a start command to a channel. With wait_for_start=True the SDK blocks until the
channel reports Running (polling up to 1200s at 20s intervals).

Safety class: C · API type: admin · Min version: -

📘

Confinement

Class C: global side effect (spins up real streaming infrastructure, billable). NON-PROD ONLY. Not folder-confined - there is no run-root to contain it; always stop_live_channel afterwards.

Signatures

def start_live_channel(sdk, live_channel_id, wait_for_start=None):
    """Start the channel. With wait_for_start=True, block until Running.
    Returns None; confirm via get_live_channel()['status']['description']."""
    return sdk.start_live_channel(live_channel_id, wait_for_start)

export async function startLiveChannel(sdk, liveChannelId, waitForStart = null) {
    // Confirm via getLiveChannel(...).status.description === "Running".
    return await sdk.startLiveChannel(liveChannelId, waitForStart);
}

Parameters

Returns

None - no payload; raises on HTTP error. Confirm via get_live_channel -> status.description == 'Running'.

Errors

• 401 unauthenticated
• 404 channel not found
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• Maps to POST /api/liveChannel/{id}/start; moves the channel from Idle → Starting
  → Running.
• A channel typically needs at least its input attached (and, for some types, two schedule
  events) before it will start - see recipes/live-channels.md.

Class C - non-prod only. Starting a channel allocates real, billable streaming
infrastructure and has no folder anchor to confine it. Skip Class C on prod; always pair
with stop_live_channel. Requires an admin session.

Real-world usage

• Maps to POST /api/liveChannel/{id}/start; moves the channel
  Idle → Starting → Running.
• A channel typically needs its input attached (and, for some types, two schedule events)
  before it will start - see recipes/live-channels.md.

Class C - non-prod only. Starting a channel allocates real, billable infrastructure
and has no folder anchor to confine it. Skip Class C on prod; always pair
with stopLiveChannel. Requires an admin session.

See also: Python ↔ JS naming map · Return shapes.