openai-realtime-console  by openai

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

created 10 months ago
3,368 stars

Top 14.7% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a React-based console application for inspecting, building, and debugging with the OpenAI Realtime API. It's designed for developers working with real-time AI interactions and WebRTC.

How It Works

The application utilizes WebRTC data channels to send and receive events with the OpenAI Realtime API, demonstrating client-side function calling. It's built on a Node.js backend using Express to serve a Vite-built React frontend, allowing developers to view JSON payloads for client and server events.

Quick Start & Requirements

  • Install dependencies: npm install
  • Start the application: npm run dev
  • Requires Node.js and an OpenAI API key.
  • Project hosted at http://localhost:3000.

Highlighted Details

  • Demonstrates WebRTC data channel communication for Realtime API events.
  • Includes client-side function calling examples.
  • Features a UI logging panel for event payloads.
  • Serves as a minimal template for real-time API integration.

Maintenance & Community

No specific community channels or maintenance details are provided in the README.

Licensing & Compatibility

  • License: MIT
  • Permissive license allows for commercial use and integration into closed-source projects.

Limitations & Caveats

The README mentions a previous WebSocket version is not recommended for browsers, implying potential limitations with the current WebRTC approach in certain browser environments.

Health Check
Last commit

1 month ago

Responsiveness

Inactive

Pull Requests (30d)
1
Issues (30d)
1
Star History
197 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.