Video API, REST: Playlist.Get
Retrieves detailed information about a specific playlist by its ID.
Returns all playlist metadata, items, and related information.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/playlists/{playlistId}
Path parameters
|
Field |
Description |
|
playlistId |
string Required field. ID of the playlist to retrieve. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"items": [
{
// Includes only one of the fields `videoId`, `episodeId`
"videoId": "string",
"episodeId": "string",
// end of the list of possible fields
"position": "string"
}
],
"stylePresetId": "string",
"createdAt": "string",
"updatedAt": "string"
}
Entity representing an ordered collection of videos or episodes.
Playlists allow organizing content into sequences for improved user experience.
|
Field |
Description |
|
id |
string Unique identifier of the playlist. |
|
channelId |
string Identifier of the channel where this playlist is created and managed. |
|
title |
string Title of the playlist displayed in interfaces and players. |
|
description |
string Detailed description of the playlist's content and purpose. |
|
items[] |
Ordered list of content items included in this playlist. |
|
stylePresetId |
string Identifier of the style preset used in the player during playlist playback. |
|
createdAt |
string (date-time) Timestamp when the playlist was initially created in the system. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Timestamp of the last modification to the playlist or its metadata. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
PlaylistItem
Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.
|
Field |
Description |
|
videoId |
string Identifier of a video included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
episodeId |
string Identifier of an episode included in the playlist. The maximum string length in characters is 50. Includes only one of the fields Specifies the content identifier type for this playlist item. |
|
position |
string (int64) Position of this item in the playlist sequence (zero-indexed). Acceptable values are 0 to 100, inclusive. |