Add new subtitle/captions to a video entity.
Add already exist subtitles
Subtitles must be in one of the following formats:
Language is 3-letter language code according to ISO-639-2 (bibliographic code). Specify language you need, or just look at our list in the attribute “audio_language” of section “AI Speech Recognition”.
You can add multiple subtitles in the same language, language uniqueness is not required.
Size must be up to 5Mb.
The update time for added or changed subtitles is up to 30 seconds. Just like videos, subtitles are cached, so it takes time to update the data.
AI subtitles and transcribing
It is also possible to automatically create subtitles based on AI.
Read more:
auto_transcribe_audio_language: auto|<language_code>, then immediately after successful transcoding, an AI task will be automatically created for transcription.auto_translate_subtitles_language: default|<language_codes,> parameter for that. Also you can point several languages to translate to, then a separate subtitle will be generated for each specified language.
The created AI-task(s) will be automatically executed, and result will also be automatically attached to this video as subtitle(s).If AI is disabled in your account, you will receive code 422 in response.
Where and how subtitles are displayed?
Subtitles are became available in the API response and in playback manifests.
All added subtitles are automatically inserted into the output manifest .m3u8. This way, subtitles become available to any player: our player, OS built-in, or other specialized ones. You don’t need to do anything else. Read more information in the Knowledge Base.
Example:
#EXT-X-MEDIA:TYPE=SUBTITLES,GROUP-ID="subs0",NAME="English",LANGUAGE="en",AUTOSELECT=YES,URI="subs-0.m3u8"

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token.
Example: apikey 1234$abcdef
ID of a video
3-letter language code according to ISO-639-2 (bibliographic code)
Name of the subtitle.
If AI is used for creating subtitles and name field is not set, then name will be taken by pattern: "{language} (AI-generated)".
Full text of subtitles/captions, with escaped "\n" ("\r") symbol of new line.
If AI is used for creating subtitles, then this field must not be set.
Automatic creation of subtitles by transcribing the audio track.
When using this option, you do not need to attach subtitle text in vtt field. The audio track will be transcribed and the subtitle will be created automatically.
Values:
Example: auto_transcribe_audio_language: ger
auto, <language_code> Automatic translation of auto-transcribed subtitles to the specified language(s). Can be used both together with auto_transcribe_audio_language option only.
Use it when you want to make automatic subtitles in languages other than the original language in audio.
Values:
If several languages are specified for translation, a separate subtitle will be generated for each language.
Example: auto_translate_subtitles_language: eng,fre,ger
Please note that subtitle translation is done separately and after transcription. Thus separate AI-tasks are created for translation.
default, <language_code,>