Video API, REST: Stream.Get
Retrieves detailed information about a specific stream by its ID.
Returns all stream metadata, status, and related information.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/streams/{streamId}
Path parameters
Field |
Description |
streamId |
string Required field. ID of the stream to retrieve. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"channelId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "string",
"startTime": "string",
"publishTime": "string",
"finishTime": "string",
"autoPublish": "boolean",
// Includes only one of the fields `onDemand`, `schedule`
"onDemand": "object",
"schedule": {
"startTime": "string",
"finishTime": "string"
},
// end of the list of possible fields
"createdAt": "string",
"updatedAt": "string",
"labels": "object"
}
Entity representing a live video stream.
A stream is a real-time video broadcast linked to a specific stream line.
Field |
Description |
id |
string Unique identifier of the stream. |
channelId |
string Identifier of the channel where the stream is created and managed. |
lineId |
string Identifier of the stream line to which this stream is linked. |
title |
string Title of the stream displayed in interfaces and players. |
description |
string Detailed description of the stream content and context. |
thumbnailId |
string Identifier of the thumbnail image used to represent the stream visually. |
status |
enum (StreamStatus) Current status of the stream.
|
startTime |
string (date-time) Timestamp when the stream was initiated. String in RFC3339 To work with values in this field, use the APIs described in the |
publishTime |
string (date-time) Timestamp when the stream was published (switched to ONAIR status). String in RFC3339 To work with values in this field, use the APIs described in the |
finishTime |
string (date-time) Timestamp when the stream was completed. String in RFC3339 To work with values in this field, use the APIs described in the |
autoPublish |
boolean Controls automatic publishing of the stream when it's ready. |
onDemand |
object On-demand stream starts immediately when a video signal appears. Includes only one of the fields Specifies the stream scheduling type. |
schedule |
Scheduled stream starts and finishes at specified time. Includes only one of the fields Specifies the stream scheduling type. |
createdAt |
string (date-time) Timestamp when the stream was initially created in the system. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Timestamp of the last modification to the stream or its metadata. String in RFC3339 To work with values in this field, use the APIs described in the |
labels |
object (map<string, string>) Custom user-defined labels as |
Schedule
Represents a scheduled stream type.
This type of stream starts and finishes automatically at specified time.
Field |
Description |
startTime |
string (date-time) Scheduled time when the stream should automatically start. String in RFC3339 To work with values in this field, use the APIs described in the |
finishTime |
string (date-time) Scheduled time when the stream should automatically finish. String in RFC3339 To work with values in this field, use the APIs described in the |