v1

latestOpenAPI 3.1.02026-07-2671117149.2 KB

Apis

Streaming

Get Stream Status

Retrieve the current status of a stream, including source connection details and the state and URLs of every output.

get/stream/{stream_id}

stream_idinteger required

Identifier returned when the stream was created.

Current state of the stream.

stream_idinteger

status1 | 2 | 3 | 4 | 5 | 6

Lifecycle status of a stream.

Value	Status	Description
1	Scheduled	Created and waiting for its start time.
2	Setting up	Resources are being provisioned.
3	Started	Live and processing.
4	Ended	Completed normally.
5	Interrupted	Stopped before its scheduled end.
6	Error	Failed; see the error field.

scheduled_atstring date-time nullable

started_atstring date-time nullable

stopped_atstring date-time nullable

task_idstring nullable

Setup task identifier.

errorstring nullable

Failure description when status is 6 (error).