Packages can be found in the packages/ directory.
Check out our examples/ to see them in action
Important
The speechmatics NPM package has been deprecated, and will not be updated further. The packages in this repo offer similar functionality. If you have any issues upgrading, don't hesitate to get in touch.
See the README.md files in each package for installation and usage details:
Official JS clients for Speechmatics APIs
-
Batch client: Upload files for transcription:
-
Real-time client: Stream audio data for real-time transcription:
-
Flow client: Interact with Flow API, our voice assistant engine:
Wrappers of the clients above to integrate into React projects:
Our philosophy is to adhere to web standard APIs as much as possible. We aim for our SDKs to work in all browsers, React Native, Deno, Bun and Cloudflare edge environments.
If you encounter any issues running out SDKs in one of these environments, please open an issue.
The documentation for the API can be found here.
More examples on how to use the SDK can be found in the examples folder.
Our Portal is also a good source of information on how to use the API. You can find it here. Check out Upload and Realtime Demo sections.
We'd love to see your contributions! Please read our contributing guidelines for more information.
- For feature requests or bugs open an issue
- To provide direct feedback, email us at devrel@speechmatics.com
- We're @speechmatics on Twitter too!