Skip to content

AwaisKamran/openai-realtime-api

Repository files navigation

OpenAI Realtime API Exploration

Welcome to the OpenAI Realtime API Exploration repository! This project is dedicated to exploring and implementing the voice-based real-time API provided by OpenAI.

About the Project

The OpenAI Realtime API allows for real-time interaction with AI models, enabling voice-based communication and natural language processing. This project aims to demonstrate the capabilities of the API and provide examples of its implementation.

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/openai-realtime-api.git
  2. Install the required dependencies: npm install
  3. Set up your OpenAI API key in the .env file.
  4. run node index.mjs to run a text conversation example
  5. run node index-audio-files.mjs to run a audio conversation example with user audio files.

Contributing

Contributions are welcome! If you have any suggestions, improvements, or new features to add, please open an issue or submit a pull request.

Acknowledgments

  • OpenAI for providing the Realtime API.
  • The contributors and maintainers of the open-source projects used in this repository.

Contact

For any questions or inquiries, please contact awais.kamran@conradlabs.com.

About

This repository explores the voice based realtime api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published