Pronunciation Vaults

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

Field	Type	Required	Description
`accent`	string	No	Admin 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

Field	Type	Required	Description
`id`	string	Yes	Vault 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.

string

required

Vault name.

string

Optional description.

string

Accent code (e.g. "en-US", "en-GB").

array

Pronunciation pairs — array of { "word": "...", "pronunciation": "..." } objects. Defaults to [].

boolean

default:"true"

Whether the vault is visible to all users.

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. Pass the vault UUID as the request id. All data fields below are optional.

string

Updated vault name.

string

Updated description.

string

Updated accent code.

array

Replacement pronunciation pairs array — replaces the existing pairs entirely.

boolean

Updated visibility flag.

Response

{
  "vault": { /* updated vault */ }
}

`delete`

Permanently deletes a pronunciation vault. Admin only. Irreversible. Parameters

Field	Type	Required	Description
`id`	string	Yes	Vault UUID (passed as request ID)

Response

{ "success": true, "message": "Vault deleted successfully" }

Error codes

Code	Meaning
`VALIDATION_ERROR`	Missing required parameter
`NOT_FOUND`	Vault not found or not public
`FORBIDDEN`	Admin access required
`INTERNAL_ERROR`	Unexpected server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Pronunciation Vaults

Actions

`all`

`get`

`create`

`update`

`delete`

Error codes

​Actions

​all

​get

​create

​update

​delete

​Error codes

Actions

`all`

`get`

`create`

`update`

`delete`

Error codes