Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.interactly.ai/llms.txt

Use this file to discover all available pages before exploring further.

Interactly Client SDK

This package lets you make calls directly to Interactly in your webapp.

Installation

Install the package:
$ npm i @interactly-ai/web

Importing

Import the package:
import Interactly from '@interaclty-ai/web';
Then, create a new instance of the Interactly class, passing your Public Key and Api base url as parameters to the constructor:
const Interactly = new Interactly({
  apiToken: 'your-api-token',
  server: 'server-base-url'
});
You can find your public key and Api base url in the Dashboard.

Usage

.start()

You can start a call by calling the start method and passing an assistantId as a parameter:
await Interactly.start('your-assistant-id');

.stop()

You can stop the call by calling the stop method:
await Interactly.stop();
This will stop the events listening and close the connection.

Events

You can listen to the following events:
  • call-start
  • call-end
  • message
  • error

Interactly.on('call-start', () => {
  console.log('Call has started');
});

Interactly.on('call-end', () => {
  console.log('Call has stopped');
});


// Assistant messages and transcripts will be sent via messages
Interactly.on('message', (message) => {
  console.log(message);
});

Interactly.on('error', (e) => {
  console.error(e);
});
These events allow you to react to changes in the state of the call or speech.

Resources

NPM

View Package on NPM.

GitHub

View Package on GitHub.