v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Create a Voice Dictionary

Creates a new voice dictionary with custom pronunciation rules.

post/v1/voice-agents/voice-dictionaries

Request body

namestring required

Name of the voice dictionary.

Example request

{
  "name": "Medical Terms Dictionary",
  "words": [
    {
      "word": "acetaminophen",
      "pronunciation": "uh-SEE-tuh-MIN-uh-fen"
    }
  ]
}

Response

Successful response

successboolean

messagestring

messageKeystring

Example response

{
  "success": true,
  "message": "Voice dictionary created successfully",
  "messageKey": "VoiceDictionaryCreatedSuccessfully",
  "data": {
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "name": "Medical Terms Dictionary",
    "words": [
      {
        "word": "acetaminophen",
        "pronunciation": "uh-SEE-tuh-MIN-uh-fen"
      }
    ],
    "createdAt": "2024-01-15T10:30:00Z"
  }
}