HTTP API
SpeakRequest
A speech synthesis request as an operator action.
Shape: object
| Property | Required | Type | Description | Rules |
|---|---|---|---|---|
text |
yes | string |
The text to speak. | — |
sessionId |
no | string |
The session the attachment is bound to. If left empty, the attachment is considered orphaned and deleted by the retention policy. | — |
voiceId |
no | string |
The identifier of the voice to use. The default voice if empty. | — |
includeTimestamps |
no | boolean |
Requests character-level timing alongside the audio. Default false. |
— |
provider |
no | string |
The registration name of the synthesizer to use; null for the default one. |
— |