Skip to main content
GET
/
api
/
v1
/
pronunciations
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.pronunciations.pronunciationsGet();

  console.log(result);
}

run();
{
  "pronunciations": [
    {
      "text": "<string>",
      "replacement": "<string>",
      "languages": [
        "<string>"
      ],
      "provider": "",
      "voice": "",
      "match_type": "exact",
      "match_options": [
        "<string>"
      ],
      "enabled": true,
      "notes": ""
    }
  ],
  "metadata": {
    "entries": 123,
    "hash": "<string>",
    "source": ""
  },
  "type": "pronunciations_v1",
  "voices": {}
}

Authorizations

​
Syllable-API-Key
string
header
required

Response

200 - application/json

Successful Response

Container for all TTS pronunciation overrides belonging to the sub-organisation.

Stored in the config_values table via ConfigDao. The Syllable API persists uploaded CSV pronunciation rules, and Bubblegum's PronunciationOverridesPlugin reads them to apply text replacements before TTS processing.

Example: dao = ConfigDao(db_session) await dao.register_model('tts.pronunciations', PronunciationOverridesDictionary)

pod = PronunciationOverridesDictionary(
    pronunciations=[...],
    metadata=DictionaryMetadata(entries=10, hash='sha256:...'),
)
result = await dao.upsert('pronunciations_v1', pod)

record = await dao.get('pronunciations_v1', PronunciationOverridesDictionary)
if record:
    pronunciations = record.value.pronunciations
​
pronunciations
PronunciationOverride · object[]
required
​
metadata
DictionaryMetadata · object
required

Audit metadata associated with a dictionary.

​
type
string
default:pronunciations_v1
​
voices
Voices · object