VoiceStudioDocs
Local reference

Pronunciation

List Entries

GET
/pronunciation

Response Body

application/json

bash
curl -X GET "https://example.com/pronunciation"
json
null

Create Entry

POST
/pronunciation

Request Body

application/json

term*Term
replacement?Replacement
Default""
type?Type
Default"respelling"
language?Language
Default"*"
enabled?Enabled
Defaulttrue

Response Body

application/json

application/json

bash
curl -X POST "https://example.com/pronunciation" \
  -H "Content-Type: application/json" \
  -d '{
    "term": "string"
  }'
json
null

Delete Entry

DELETE
/pronunciation/{entry_id}

Path Parameters

entry_id*Entry Id

Response Body

application/json

application/json

bash
curl -X DELETE "https://example.com/pronunciation/string"
json
null

Update Entry

PUT
/pronunciation/{entry_id}

Path Parameters

entry_id*Entry Id

Request Body

application/json

term?string|null
replacement?string|null
type?string|null
language?string|null
enabled?boolean|null

Response Body

application/json

application/json

bash
curl -X PUT "https://example.com/pronunciation/string" \
  -H "Content-Type: application/json" \
  -d '{}'
json
null

Test Substitution

POST
/pronunciation/test

Show the post-substitution text for req.text — no model call.

Applies the same dictionary + inline [[…]] resolution the synth path runs, so the user sees exactly what the engine will be handed.

Request Body

application/json

text*Text
language?string|null

Response Body

application/json

application/json

bash
curl -X POST "https://example.com/pronunciation/test" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "string"
  }'
json
null

Export Entries

GET
/pronunciation/export

Every entry as a JSON-serializable list (round-trips /import).

Response Body

application/json

bash
curl -X GET "https://example.com/pronunciation/export"
json
null

Import Entries

POST
/pronunciation/import

Bulk-add entries. replace=true clears the table first.

Each entry is validated like POST /pronunciation; one bad row fails the whole import (400) so the table is never left half-applied.

Request Body

application/json

entries*array<>
replace?Replace
Defaultfalse

Response Body

application/json

application/json

bash
curl -X POST "https://example.com/pronunciation/import" \
  -H "Content-Type: application/json" \
  -d '{
    "entries": [
      {
        "term": "string"
      }
    ]
  }'
json
null

Engines

Previous Page

Watermark

Next Page