Create or update system speech word

PUT

/speech-words/{filename}

Last modified:2026-10-03 14:35:08

OperationId:UpdateSpeechWord

Sets the text, voice, and silence padding of a system speech word, creating it when it does not exist. The change applies to every domain that does not override the word.

Requires Super User scope. A Reseller changes speech words only as overrides for domains in its own reseller.

Fields you leave out keep their stored value. A new speech word takes them from the system speech word of the same name, so script is required only when there is none. Changing the text or voice does not record new audio: call the matching /render endpoint afterward, or upload audio. The response is the stored record; read the speech word for its recording state and playback link.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The stored speech word.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

cURL

Change the textChange the voice

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/speech-words/hour-10' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "script": "ten o clock"
}'

Response Example

200 - Change the text

{
    "filename": "hour-10",
    "domain": "*",
    "language": "en_us",
    "script": "ten o clock",
    "voice-engine": "WaveNet",
    "voice-id": "en-US-Wavenet-C",
    "voice-language": "en-US",
    "source-type": "tts",
    "content-hash": "3f786850e387550fdab836ed7e6dc881de23001b",
    "pre-silence-ms": 500,
    "post-silence-ms": 200,
    "created-datetime": "2026-09-01T14:30:00+00:00",
    "updated-datetime": "2026-10-01T14:30:00+00:00"
}

Modified at 2026-10-03 14:35:08

Read system speech word

Download system speech word audio