Skip to main content

OpenAI Node

The OpenAI Node processes incoming audio by forwarding it to OpenAI's real-time audio API. It then outputs the audio response generated by OpenAI, enabling seamless integration of AI-powered audio interactions.

Number of inputs1
Number of outputs1

Configuration​

apiKey (Optional)​

Type: String

The API key to use when connecting to the OpenAI API. If not provided, the API key set at extension initialization will be used.

voice (Optional)​

Type: String

The voice to use for the response audio. Valid values are: "alloy", "ash", "ballad", "coral", "echo", "fable", "onyx", "nova", "sage", "shimmer", "verse"


Properties​

instructions​

Type: String

Instructions for the AI voice.

speed​

Type: Float

Speech speed multiplier. 1.0 is normal speed. Value must be between 0.5 and 1.5

temperature​

Type: Float

Sampling temperature. Higher values mean more random responses. Value must be between 0.6 and 1.2

Inherits properties from its parent, SingleBusAudioProcessorNode.


Actions​

updateSession​

Updates the OpenAI session with new parameters.

Parameters​

None.

Return Value​

None.

Inherits actions from its parent, SingleBusAudioProcessorNode.


Events​

Inherits events from its parent, SingleBusAudioProcessorNode.