https://github.com/assemblyai/realtime-transcription-browser-js-example
Demo of AssemblyAI's Real-Time Websocket API (In Browser with JavaScript)
https://github.com/assemblyai/realtime-transcription-browser-js-example
Last synced: about 1 year ago
JSON representation
Demo of AssemblyAI's Real-Time Websocket API (In Browser with JavaScript)
- Host: GitHub
- URL: https://github.com/assemblyai/realtime-transcription-browser-js-example
- Owner: AssemblyAI
- License: mit
- Created: 2021-07-27T02:25:26.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T18:54:32.000Z (about 2 years ago)
- Last Synced: 2024-02-20T19:57:17.709Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 31.2 MB
- Stars: 78
- Watchers: 5
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AssemblyAI Real-Time Transcription Browser Example
This open-source repo provided by AssemblyAI displays how to use our real-time API in the browser!
In this app, we grab an audio stream from the user's computer and then send that over a WebSocket to AssemblyAI for real-time transcription. Once AssemblyAI begins transcribing, we display the text in the browser. This is accomplished using Express for our backend and the AudioWorklet to process the raw audio.
## How To Install and Run the Project
##### ❗Important❗
- Before running this app, you need to upgrade your AssemblyAI account. The real-time API is only available to upgraded accounts at this time.
- Running the app before upgrading will cause an **error with a 402 status code.** ⚠️
- To upgrade your account you need to add a card. You can do that in your dashboard [here](https://app.assemblyai.com/)!
##### Instructions
1. Clone the repo to your local machine.
2. Open a terminal in the main directory housing the project. In this case `realtime-transcription-browser-js-example`.
3. Run `yarn install` to ensure all dependencies are installed.
4. Create a .env file and set your AssemblyAI API key. Use the [.env.example](./.env.example) as a reference.
5. Start the application with the command `yarn serve` (will run on port 8000).
## Further Documentation
- [AssemblyAI Real-Time Documentation](https://www.assemblyai.com/docs/speech-to-text/real-time)
- [MDN AudioWorklet](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet)
- [Express](https://expressjs.com/)
## Contact Us
If you have any questions, please feel free to reach out to our Support team - support@assemblyai.com!