Fields for Auto Captions and Transcripts
Field Type Required Description
autodetect boolean no true to auto-detect language from audio source. false to use srclang specifying the audio language.
default boolean no If true, srclang will be ignored, and the main audio track will be used - language will be auto-detected.
input_audio_track object no For multiple audio tracks, defines the audio to extract the captions from. It is composed by language and variant (both required).
kind string no The kind of output to generate. Allowed values:
  • captions
  • transcripts
Notes:
  1. If the kind is transcripts, and the url for the transcripts file is included, a transcript file will be ingested, and no auto captions will be generated. See Ingesting Transcriptions for more details.
  2. If the kind is transcripts, and the url for the transcripts file is not included, a transcript file and captions will be generated,
  3. If the kind is captions, a captions will be generated, but not a transcript file.
label string no Human readable label. Defaults to the BCP-47 style language code.
srclang string no BCP-47 style language code for the text tracks (en-US, fr-FR, es-ES, etc.); see supported languages
status string no Indicates the actual situation of the caption, if it is published, draft.
url string no The URL where a transcript file is located. Must be included in the kind is transcripts. Must not be included if the kind is captions.