Contact UsGet started

Video API, REST: Subtitle.List

Written by
Updated at April 24, 2025

List subtitles.

HTTP request

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

Query parameters

Field

Description

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.

videoId

string

ID of the video.

Includes only one of the fields videoId.

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[]

Subtitle

nextPageToken

string

Token for getting the next page.

Subtitle

Field

Description

id

string

ID of the subtitle.

language

string

Subtitle language in any of the following formats:

  • three-letter code according to ISO 639-2/T, ISO 639-2/B, or ISO 639-3
  • two-letter code according to ISO 639-1

label

string

Subtitle caption to be displayed on screen during video playback.

status

enum (SubtitleStatus)

Subtitle status.

  • SUBTITLE_STATUS_UNSPECIFIED: Subtitle status unspecified.
  • WAIT_UPLOADING: Waiting for all the bytes to be loaded.
  • UPLOADED: Uploading is complete.

sourceType

enum (SubtitleSourceType)

Source type.

  • SUBTITLE_SOURCE_TYPE_UNSPECIFIED: Subtitle source type unspecified.
  • MANUAL: Manually uploaded subtitle.
  • GENERATED: Automatically generated subtitle.

filename

string

Subtitle filename.

createdAt

string (date-time)

Time when subtitle 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 subtitle 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).

videoId

string

ID of the video.

Includes only one of the fields videoId.
Previous
Get
Next
Create