TTS OpenAI Http

Article summary

Did you find this summary helpful?

Thank you for your feedback!

OpenAI Text To Speech Integration Node

Parameters

name	description	default
OpenAI API Token	OpenAI API Key
OpenAI Model	OpenAI Model For TTS	gpt-4o-mini-tts
OpenAI Voice Name	The name of the voice	alloy
OpenAI TTS Instructions	Specific instructions for OpenAI TTS, can be detailed for more specialization	Speak in a cheerful and positive tone.
OpenAI TTS Speed	Speed of the TTS Voice	1.0

none

name	description	known nodes that generate this event
Every Event that Contains the `Data.Text` field	A TTS Synthesis audio can be generated from any event that is text based. Users can also generate their custom event that has `Data.Text` and send it through the Entry, or External Relay nodes.	SR Http, SR WebSocket, Translate

Syntesized speech is sent to output in PCM16 Format With a Wave header.

name	description
Start of TTS Fragment	This event is sent just before a TTS operation writes the result to Audio output. Contains the Text that was used for the synthesis under the `Data.Text` field.
End of TTS Fragment	This event is send just after a TTS operation has finished writing to Audio output.

The node needs an OpenAI Api key to perform. To learn more about getting an API Key and finding it, you can refer to the OpenAI Api page.

After getting your API Key, you can learn about finding and securely using your key following the instructions on this page.

You can also see which models are available through the OpenAI Models page.

The list of available voices can be found here

A sample tts-request event would look as follows.

{
    "Event": {
        "Name": "Custom TTS Event",
        "Channel": 0,
        "Data" : {
            "Text": "hello world"
        }
    }
}

Channel: Channel number is necessary for locating the node that will perform the TTS operation.
Data.Text: The text that will be synthesized.

Sending Custom Events to Projects

To learn more about sending Events to projects, you can check the HTTP and External Relay pages.

The project structures defined in TTS Http page all apply to this node as well.

Stream, Batch

v3.7.0

Was this article helpful?

Table of contents