Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@speechmatics/real-time-client

speechmatics-devrel20.9kMIT7.0.2TypeScript support: included

Client for the Speechmatics real-time API

speech, ASR, real-time, realtime, real time, websocket, transcript, translation

readme

Speechmatics real-time client 🎤

Official JS client for the Speechmatics real-time transcription API.

API documentation can be found here: https://docs.speechmatics.com/rt-api-ref

Installation

npm i @speechmatics/real-time-client

[!WARNING]
For React Native, make sure to install the event-target-polyfill package, or any other polyfill for the EventTarget class

Usage

More examples will be available soon. For now, you can checkout the NodeJS example.

API keys 🔑

You can generate a long-lived API key through our self service portal here: https://portal.speechmatics.com/api-keys

See our documentation about generating short-lived JWTs here: https://docs.speechmatics.com/introduction/authentication