Render system speech word with text to speech

POST

/speech-words/{filename}/render

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

OperationId:RenderSpeechWord

Records a speech word with text to speech, from its stored text and voice or the values you send, and stores the text and voice used.

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

The audio replaces the system audio, which every domain without an override plays. Rendering calls the text-to-speech service and waits for it, so the response can take several seconds. A speech word whose stored text, voice, and silence already match its recorded file is not rendered again. The voice is matched by id or name among the voices for voice-language; when none matches, the first voice for the language is used. Render many speech words in one call with the bulk /render endpoint.

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/json

Examples

Responses

🟢200OK

application/json

The speech word is current. code in the body is 201 with message Rendered when new audio was recorded, or 200 with Already up to date when the stored audio already matched.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🔴500Internal Server Error

🔴502Bad Gateway

Request Example

Shell

JavaScript

Java

Swift

cURL

Stored text and voiceNew voice

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

Response Example

200 - Rendered

{
    "code": 201,
    "message": "Rendered",
    "content-hash": "8c1f1046219ddd216a023f792356ddf127fce372",
    "source-type": "tts"
}

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

Download system speech word audio

Upload system speech word audio