Skip to main content
Pronunciation Vaults are shared libraries of word-to-phonetic mappings. Regular users can read public vaults; creating, updating, and deleting vaults is restricted to admins.

​
Actions

​
all

Returns all pronunciation vaults. Regular users only see public vaults. Admins see all vaults and can filter by accent. Parameters
FieldTypeRequiredDescription
accentstringNoAdmin only — filter by accent code
Response 
{
  "vaults": [
    {
      "id": "vault-uuid",
      "name": "General American English",
      "description": "Standard US English pronunciation guide",
      "accent": "en-US",
      "pairs": [
        { "word": "HelpGenie", "pronunciation": "help JEE-nee" }
      ],
      "is_public": true,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 3
}

​
get

Returns a single pronunciation vault by ID. Returns NOT_FOUND for non-public vaults accessed by regular users. Parameters
FieldTypeRequiredDescription
idstringYesVault UUID (passed as request ID)
Response 
{
  "vault": {
    "id": "vault-uuid",
    "name": "General American English",
    "description": "Standard US English pronunciation guide",
    "accent": "en-US",
    "pairs": [ /* pronunciation pairs */ ],
    "is_public": true,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

​
create

Creates a new pronunciation vault. Admin only. Parameters
FieldTypeRequiredDescription
namestringYesVault name
descriptionstringNoOptional description
accentstringNoAccent code (e.g. "en-US", "en-GB")
pairsarrayNoPronunciation pairs — array of { word, pronunciation } objects
is_publicbooleanNoWhether the vault is visible to all users, defaults to true
Response — 201 
{
  "vault": {
    "id": "vault-uuid",
    "name": "General American English",
    "pairs": [],
    "is_public": true,
    "created_at": "2024-01-01T00:00:00Z"
  }
}

​
update

Updates a pronunciation vault. Admin only. Partial updates supported — only supplied fields are changed. Parameters
FieldTypeRequiredDescription
idstringYesVault UUID (passed as request ID)
namestringNoUpdated name
descriptionstringNoUpdated description
accentstringNoUpdated accent code
pairsarrayNoReplacement pronunciation pairs array
is_publicbooleanNoUpdated visibility
Response 
{
  "vault": { /* updated vault */ }
}

​
delete

Permanently deletes a pronunciation vault. Admin only. Irreversible. Parameters
FieldTypeRequiredDescription
idstringYesVault UUID (passed as request ID)
Response 
{ "success": true, "message": "Vault deleted successfully" }

​
Error codes

CodeMeaning
VALIDATION_ERRORMissing required parameter
NOT_FOUNDVault not found or not public
FORBIDDENAdmin access required
INTERNAL_ERRORUnexpected server error