Skip to content

React app for inspecting, building and debugging with the Realtime API

License

Notifications You must be signed in to change notification settings

openai/openai-realtime-console

Repository files navigation

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. Export it as a system environment variable:

export OPENAI_API_KEY=<your key here>

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.

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