Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud Video
    • Overview
    • Control
    • Troubleshooting
  • Access management
  • Pricing policy
    • API authentication
    • Getting started with the API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • GenerateUploadURL
        • Delete
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • CreateSubtitleRequest
  • SubtitleUploadParams
  • operation.Operation
  • CreateSubtitleMetadata
  • Subtitle
  1. API reference
  2. gRPC
  3. Subtitle
  4. Create

Video API, gRPC: SubtitleService.Create

Written by
Yandex Cloud
Updated at August 8, 2025
  • gRPC request
  • CreateSubtitleRequest
  • SubtitleUploadParams
  • operation.Operation
  • CreateSubtitleMetadata
  • Subtitle

Creates a new subtitle record for a specific video.
This method only creates the metadata record; the actual subtitle file must be uploaded
using the URL obtained from the GenerateUploadURL method.

gRPC requestgRPC request

rpc Create (CreateSubtitleRequest) returns (operation.Operation)

CreateSubtitleRequestCreateSubtitleRequest

{
  "language": "string",
  "label": "string",
  // Includes only one of the fields `video_id`
  "video_id": "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 represented as a three-letter code according to ISO 639-2/T.

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.

video_id

string

ID of the video.

Includes only one of the fields video_id.

upload

SubtitleUploadParams

Upload subtitle.

Includes only one of the fields upload.

Source type.

SubtitleUploadParamsSubtitleUploadParams

Field

Description

filename

string

Required field. Original filename of the subtitle file being uploaded.

operation.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "subtitle_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "language": "string",
    "label": "string",
    "status": "SubtitleStatus",
    "source_type": "SubtitleSourceType",
    "filename": "string",
    "created_at": "google.protobuf.Timestamp",
    "updated_at": "google.protobuf.Timestamp",
    // Includes only one of the fields `video_id`
    "video_id": "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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

google.rpc.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.

CreateSubtitleMetadataCreateSubtitleMetadata

Field

Description

subtitle_id

string

ID of the subtitle being created.

SubtitleSubtitle

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.

  • SUBTITLE_STATUS_UNSPECIFIED: The subtitle status is not specified.
  • WAIT_UPLOADING: The subtitle file upload is in progress, waiting for all bytes to be received.
  • UPLOADED: The subtitle file has been fully uploaded and is ready for use.

source_type

enum SubtitleSourceType

Indicates how the subtitle was created or obtained.

  • SUBTITLE_SOURCE_TYPE_UNSPECIFIED: The subtitle source type is not specified.
  • MANUAL: The subtitle was manually created and uploaded by a user.
  • GENERATED: The subtitle was automatically generated through speech recognition.

filename

string

Original filename of the subtitle file.

created_at

google.protobuf.Timestamp

Timestamp when the subtitle was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the subtitle or its metadata.

video_id

string

Identifier of the video this subtitle belongs to.

Includes only one of the fields video_id.

Specifies the parent content this subtitle is associated with.

Was the article helpful?

Previous
List
Next
GenerateUploadURL
© 2025 Direct Cursus Technology L.L.C.