API Reference
API Reference

Get Pronunciations Dictionary

GET/api/v1/pronunciations

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Responses

200Successful Response

application/json

response PronunciationOverridesDictionary required
4 fields
typestringoptional
Default pronunciations_v1Pattern ^pronunciations_v\d+$
pronunciationsPronunciationOverride[]required
Item schema
itemsPronunciationOverriderequired

A single text replacement rule.

9 fields
textstringrequired
Minimum length 1
replacementstringrequired
Minimum length 1
languagesstring[]optional
Item schema
itemsstringrequired
providerstringoptional
Default
voicestringoptional
Default
match_typeenum<string>optional

Matching strategy for override text.

Allowed values ["exact","substring"]Default exact
match_optionsstring[]optional
Item schema
itemsstringrequired
enabledbooleanoptional
Default true
notesstringoptional
Default
voicesobjectoptional
1 field
{key}VoiceDisplayInfooptional

Display metadata for a canonical voice identifier.

2 fields
display_namestringrequired
providerstringrequired
metadataDictionaryMetadatarequired

Audit metadata associated with a dictionary.

3 fields
entriesintegerrequired
hashstringrequired
sourcestringoptional
Default
Response example
{
  "type": "pronunciations_v1",
  "pronunciations": [
    {
      "text": "string",
      "replacement": "string",
      "languages": [
        "string"
      ],
      "provider": "",
      "voice": "",
      "match_type": "exact",
      "match_options": [
        "string"
      ],
      "enabled": true,
      "notes": ""
    }
  ],
  "voices": "string",
  "metadata": {
    "entries": 0,
    "hash": "string",
    "source": ""
  }
}