Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

s2s/openai

OpenAI Realtime speech-to-speech voice agent using the s2s verb over WebSocket transport.

Connects the caller to OpenAI's Realtime API for a real-time voice conversation with server-side VAD turn detection. Demonstrates:

  • The s2s verb with vendor: 'openai'
  • response_create configuration (voice, modalities, instructions)
  • session_update for VAD turn detection and audio transcription
  • API key authentication
  • The actionHook callback for session completion

Setup

npm install

Application Variables

Configured in the jambonz portal and passed via session.data.env_vars:

Variable Default Description
OPENAI_API_KEY OpenAI API key (required)

Environment Variables

Variable Default Description
PORT 3000 Port the WebSocket server listens on
LOG_LEVEL info Pino log level (debug, info, warn, error)

Running

npm start

Configure your jambonz application to use the WebSocket URL ws://your-server:3000/.