Skip to Content

Web SDK

Using our Web SDK makes it easy to integrate Shen.ai into a new or existing web application.

The Web SDK is not supported inside Android WebView. Consider using Chrome Custom Tabs, a full browser page, or the native Android SDK. Chrome Custom Tabs still require the same headers and permissions.

The best way to get started is to download and run the example app:

  • See here  for a minimal example using pure Javascript.
  • See here  for a minimal example using React and Vite.
  • See here  for a minimal example using Vue 3 and Vite.
  • See here  for a minimal example using Angular.
  • See here  for the source code of playground.shen.ai  which uses Next.js + Typescript.

Installing the SDK package

See the Customer Portal for SDK downloads.

Using a package manager

When using a package manager like npm, yarn or pnpm, place the downloaded package in your project directory and unzip it, creating a directory named shenai-sdk.

Then, reference that local package in your package.json:

{ "dependencies": { "shenai-sdk": "file:shenai-sdk" } }

Further steps

Please see permissions, initialization, configuration and video measurement for further steps.