Overview

This is the core Typescript SDK for Hume's Empathic Voice Interface, making it easy to integrate the voice API into your own front-end application. This package contains helper functions for creating a client token, managing the websocket connection, and managing microphone and audio connections. The package also contains all the basic Typescript type definitions needed to interact with the voice API.

Prerequisites

Before installing this package, please ensure your development environment meets the following requirement:

• Node.js (v18.0.0 or higher).

To verify your Node.js version, run this command in your terminal:

node --version

If your Node.js version is below 18.0.0, update it to meet the requirement. For updating Node.js, visit Node.js' official site or use a version management tool like nvm for a more seamless upgrade process.

Installation

Add @humeai/voice to your project by running this command in your project directory:

npm install @humeai/voice

This will download and include the package in your project, making it ready for import and use within your web application.

Usage

Quickstart

Please refer to our documentation page for a usage guide. An example Typescript implementation can also be found here.

We also offer a empathic voice React SDK, which we recommend for anyone building with React. This SDK comes with built-in message history and microphone management, which you may find helpful.

Support

If you have questions or require assistance pertaining to this package, reach out to us on Discord!