Contact UsGet started

Video API, REST: Episode.List

Written by
Updated at April 24, 2025

List episodes for stream or line.

HTTP request

GET https://video.api.cloud.yandex.net/video/v1/episodes

Query parameters

Field

Description

streamId

string

ID of the stream.

Includes only one of the fields streamId, lineId.

lineId

string

ID of the line.

Includes only one of the fields streamId, lineId.

pageSize

string (int64)

The maximum number of the results per page to return.
Default value: 100.

pageToken

string

Page token for getting the next page of the result.

orderBy

string

By which column the listing should be ordered and in which direction,
format is " " (e.g. "createdAt desc").
Default: "id asc".
Possible fields: ["id", "createdAt", "updatedAt"].
Both snake_case and camelCase are supported for fields.

filter

string

Filter expression that filters resources listed in the response.
Expressions are composed of terms connected by logic operators.
If value contains spaces or quotes,
it should be in quotes (' or ") with the inner quotes being backslash escaped.
Supported logical operators: ["AND", "OR"].
Supported string match operators: ["=", "!=", ":"].
Operator ":" stands for substring matching.
Filter expressions may also contain parentheses to group logical operands.
Example: key1='value' AND (key2!='\'value\'' OR key2:"\"value\"")
Supported fields: ["id", "title"].
Both snake_case and camelCase are supported for fields.

Response

HTTP Code: 200 - OK

{
  "episodes": [
    {
      "id": "string",
      "streamId": "string",
      "lineId": "string",
      "title": "string",
      "description": "string",
      "thumbnailId": "string",
      "startTime": "string",
      "finishTime": "string",
      "dvrSeconds": "string",
      "visibilityStatus": "string",
      // Includes only one of the fields `publicAccess`, `authSystemAccess`, `signUrlAccess`
      "publicAccess": "object",
      "authSystemAccess": "object",
      "signUrlAccess": "object",
      // end of the list of possible fields
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

episodes[]

Episode

List of episodes for specific parent_id.

nextPageToken

string

Token for getting the next page.

Episode

Field

Description

id

string

ID of the episode.

streamId

string

ID of the stream. Optional, empty if the episode is linked to the line

lineId

string

ID of the line. Optional, empty if the episode is linked to the stream

title

string

Episode title.

description

string

Episode description.

thumbnailId

string

ID of the thumbnail.

startTime

string (date-time)

Episode start time.

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)

Episode finish time.

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).

dvrSeconds

string (int64)

Enables episode DVR mode.
Determines how many last seconds of the stream are available for watching.

Possible values:

  • 0: infinite dvr size, the full length of the stream allowed to display
  • >0: size of dvr window in seconds, the minimum value is 30s

visibilityStatus

enum (VisibilityStatus)

  • VISIBILITY_STATUS_UNSPECIFIED
  • PUBLISHED
  • UNPUBLISHED

publicAccess

object

Episode is available to everyone.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

authSystemAccess

object

Checking access rights using the authorization system.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

signUrlAccess

object

Checking access rights using url's signature.

Includes only one of the fields publicAccess, authSystemAccess, signUrlAccess.

Episode access rights.

createdAt

string (date-time)

Time when episode was created.

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)

Time of last episode update.

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).
Previous
Get
Next
BatchGet