Contact UsGet started

Video API, REST: Subtitle.Create

Written by
Updated at April 24, 2025

Create a new subtitle.

HTTP request

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

Body parameters

{
  "language": "string",
  "label": "string",
  // Includes only one of the fields `videoId`
  "videoId": "string",
  // end of the list of possible fields
  // Includes only one of the fields `upload`
  "upload": {
    "filename": "string"
  }
  // end of the list of possible fields
}

Field

Description

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

Contains the subtitle label (or title) that will be displayed on screen during video playback.
Should provide a concise and accurate representation of the spoken content.
If not provided, it will be auto-generated based on the specified language.

videoId

string

ID of the video.

Includes only one of the fields videoId.

upload

SubtitleUploadParams

Upload subtitle.

Includes only one of the fields upload.

Source type.

SubtitleUploadParams

Field

Description

filename

string

Required field.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "subtitleId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateSubtitleMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Subtitle

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateSubtitleMetadata

Field

Description

subtitleId

string

ID of the subtitle.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

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
List
Next
GenerateUploadURL