Связаться с намиПодключиться

Video API, REST: Stream.Get

Статья создана
Обновлена 25 ноября 2025 г.

Retrieves detailed information about a specific stream by its ID.
Returns all stream metadata, status, and related information.

HTTP request

GET https://video.api.yandexcloud.kz/video/v1/streams/{streamId}

Path parameters

Field

Description

streamId

string

Required field. ID of the stream to retrieve.

The maximum string length in characters is 50.

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.

  • STREAM_STATUS_UNSPECIFIED: The stream status is not specified.
  • OFFLINE: The stream is offline and not broadcasting.
  • PREPARING: The system is preparing the infrastructure for receiving the video signal.
  • READY: The infrastructure is ready to launch the stream.
  • ONAIR: The stream is currently broadcasting live.
  • FINISHED: The stream has completed and is no longer broadcasting.

startTime

string (date-time)

Timestamp when the stream was initiated.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

publishTime

string (date-time)

Timestamp when the stream was published (switched to ONAIR status).

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

finishTime

string (date-time)

Timestamp when the stream was completed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

autoPublish

boolean

Controls automatic publishing of the stream when it's ready.
When set to true, automatically switches status from READY to ONAIR.

onDemand

object

On-demand stream starts immediately when a video signal appears.

Includes only one of the fields onDemand, schedule.

Specifies the stream scheduling type.

schedule

Schedule

Scheduled stream starts and finishes at specified time.

Includes only one of the fields onDemand, schedule.

Specifies the stream scheduling type.

createdAt

string (date-time)

Timestamp when the stream was initially created in the system.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Timestamp of the last modification to the stream or its metadata.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Custom user-defined labels as key:value pairs.
Maximum 64 labels per stream.
Used for organization, filtering, and metadata purposes.
Labels can be used for organization, filtering, and metadata purposes.

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 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

finishTime

string (date-time)

Scheduled time when the stream should automatically finish.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Предыдущая
Overview
Следующая
List