README.md

OpenAI Realtime Console

This is an example application showing how to use the OpenAI Realtime API with WebRTC.

Installation and usage

Before you begin, you'll need an OpenAI API key - create one in the dashboard here. Create a .env file from the example file and set your API key in there:

cp .env.example .env

Running this application locally requires Node.js to be installed. Install dependencies for the application with:

npm install

Start the application server with:

npm run dev

This should start the console application on http://localhost:3000.

Note: The server.js file uses @fastify/vite to build and serve the Astro frontend contained in the /client folder. You can find the configuration in the vite.config.js file

Previous WebSockets version

The previous version of this application that used WebSockets on the client (not recommended in client-side browsers) can be found here.

License

MIT