Openai Realtime Python

Realtime Agent

This project demonstrates how to deliver ultra-low latency access to OpenAI with exceptional audio quality using Agora's SD-RTN and OpenAI's Realtime API. By integrating Agora's SDK with OpenAI's Realtime API, it ensures seamless performance and minimal delay across the globe.

Prerequisites

Before running the demo, ensure you have the following installed and configured:

• Python 3.11 or above

• Agora account:

  • Login to Agora
  • Create a New Project, using Secured mode: APP ID + Token to obtain an App ID and App Certificate.

• OpenAI account:

  • Login to OpenAI
  • Go to Dashboard and obtain your API key.

• Additional Packages:

  • On macOS:

    brew install ffmpeg portaudio

  • On Ubuntu (verified on versions 22.04 & 24.04):

    sudo apt install portaudio19-dev python3-dev build-essential
    sudo apt install ffmpeg

Network Architecture

Organization of this Repo

• realtimeAgent/realtime contains the Python implementation for interacting with the Realtime API.
• realtimeAgent/agent.py includes a demo agent that leverages the realtime module and the agora-realtime-ai-api package to build a simple application.
• realtimeAgent/main.py provides a web server that allows clients to start and stop AI-driven agents.

Run the Demo

Setup and run the backend

1. Create a .env file for the backend. Copy .env.example to .env in the root of the repo and fill in the required values: