Skip to Content
Mux Docs: Home
Update a Transcription Vocabulary
put

Updates the details of a previously-created Transcription Vocabulary. Updates to Transcription Vocabularies are allowed while associated live streams are active. However, updates will not be applied to those streams while they are active.

Request body params
name
string

The user-supplied name of the Transcription Vocabulary.

phrases
array

Phrases, individual words, or proper names to include in the Transcription Vocabulary. When the Transcription Vocabulary is attached to a live stream's generated_subtitles, the probability of successful speech recognition for these words or phrases is boosted.

passthrough
string

Arbitrary user-supplied metadata set for the Transcription Vocabulary. Max 255 characters.

Request path & query params
TRANSCRIPTION_VOCABULARY_ID
string

The ID of the Transcription Vocabulary.

put
200
/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}
Request
(application/json)
{
  "name": "Mux API Vocabulary - Updated",
  "phrases": [
    "Mux",
    "Live Stream",
    "RTMP",
    "Stream Key"
  ]
}
Response
(application/json)
{
  "data": {
    "id": "VDm3npt2eaEDvz9emzun8Q",
    "name": "Mux API Vocabulary - Updated",
    "phrases": [
      "Mux",
      "Live Stream",
      "RTMP",
      "Stream Key"
    ],
    "created_at": "1609869152",
    "updated_at": "1609870000"
  }
}