Video API, REST: Subtitle.List
Lists all subtitles associated with a specific video with pagination support.
Results can be filtered and sorted using the provided parameters.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/subtitles
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of subtitles to return per page. The maximum value is 100. |
|
pageToken |
string Page token for retrieving the next page of results. The maximum string length in characters is 15000. |
|
videoId |
string ID of the video containing the subtitles to list. The maximum string length in characters is 50. Includes only one of the fields Specifies the parent resource to list subtitles from (exactly one must be chosen). |
Response
HTTP Code: 200 - OK
{
"subtitles": [
{
"id": "string",
"language": "string",
"label": "string",
"status": "string",
"sourceType": "string",
"filename": "string",
"createdAt": "string",
"updatedAt": "string",
// Includes only one of the fields `videoId`
"videoId": "string"
// end of the list of possible fields
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
subtitles[] |
List of subtitles matching the request criteria. |
|
nextPageToken |
string Token for retrieving the next page of results. |
Subtitle
Entity representing a subtitle track that can be associated with a video.
Subtitles provide text versions of the audio content, enabling accessibility
and multilingual support for video content.
|
Field |
Description |
|
id |
string Unique identifier of the subtitle track. |
|
language |
string Language of the subtitle content according to ISO 639-2/T. |
|
label |
string Display label for the subtitle track shown in the video player's subtitle selection menu. |
|
status |
enum (SubtitleStatus) Current processing status of the subtitle.
|
|
sourceType |
enum (SubtitleSourceType) Indicates how the subtitle was created or obtained.
|
|
filename |
string Original filename of the subtitle file. |
|
createdAt |
string (date-time) Timestamp when the subtitle 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 subtitle 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 |
|
videoId |
string Identifier of the video this subtitle belongs to. Includes only one of the fields Specifies the parent content this subtitle is associated with. |