Using the embed code option you can host the Digital Person on your website and have a conversation with your Digital Person. This does not require any custom development and is the fastest way to integrate.
The code snippet must be added into your website’s HTML code. The Digital Person displayed on the web page comes with a default styling in a square frame at the bottom right corner of the page with a configurable greeting text.
Key features:
Click-to-start functionality
Supports session persistence
Supports Content cards
Configurable greeting text and profile picture
The user can control the camera and microphone permissions whenever they want during the session using the icons within the widget. The camera and microphone options are both turned off when the widget loads, allowing you to select either or both. The browser would require you to grant microphone and/or camera permissions for an enhanced interactive experience with the Digital Person. Upon session time out, the widget returns to the initial state, where the profile picture and greeting message are displayed.
Communicating to a Digital Person requires you to grant microphone (audio only connection) and/or camera (video connection) permissions the first time you interact with the Digital Person on the webpage
Below are some guidelines for using it on some common websites:
| Child pages (Children Display) |
|---|
Obtaining code for your project
The code used to embed into the website is the same for every project, except for the API Key which you must provide separately.
To copy the code:
Go to the Digital DNA Studio dashboard and open the project.
Expand the Embed Code option on the Project Management page.
Copy the code or save it as a text file.
Replace the
YOUR_API_KEYvalue with the web API key you generate for your project. See Connecting Using API Keys for details.
Customizing the Widget
The code snippet SM_CONFIG can be edited to include the below additional parameters to customize the experience:
| Code Block | ||
|---|---|---|
| ||
<script
src="https://static.soulmachines.com/dev/widget-snippet.min.js"
data-sm-api-key="'YOUR_API_KEY'"
data-sm-greeting="Welcome"
data-sm-profile-picture="https://assets.cdn.soulmachines.cloud/AvatarCoverImages/image-sam-l.jpg"
></script> |
Parameter | Required/Optional | Description |
|---|---|---|
| required | This is the Web API Keys you generated for your project. |
| alternative | This is the JTW Token generated for the project. If you wish to use the JWT token instead of apiKey, you must delete the |
| optional | URL of an image of the Digital Person in a publicly accessible location. Supports an image in jpg, gif, and png format. |
| optional | This can be used to configure the greeting text displayed on the screen to encourage the users to interact with the Digital Person. The greeting cannot be turned off. If it is not configured then a default greeting is displayed: |
Changing the Profile Picture
When the session starts, the image of the digital person is not displayed by default; you can work around this problem by using the data-sm-profile-picture parameter and displaying a static image or using a gif of the digital person.
Default Profile Image
Download the image of the Digital Person you are using in the project by right-clicking the image under the “WHAT LOOK IS RIGHT FOR YOU?” section in Digital DNA Studio, and then click Save as Picture. (Or create a gif of the Digital Person)
Place the image/gif in a publicly accessible location, so that you can obtain its URL.
Use the URL in the
data-sm-profile-pictureparameter in the code snippet.
Content Cards Support
The widget currently offers the following content card options for displaying rich content. See the section Displaying Content Cards to understand how to configure these content cards in your corpus. When configured, the cards appear on top of the Digital Person Widget as a floating card as shown below:
Options Card
Displays a clickable list of options
External Links Card
Displays a clickable link to an external website. The external link card can optionally display an image and description. If not present in the data it will be hidden. The clickable link navigates the user to the external website in a new tab in the browser.
Image Card
Displays a remotely hosted image above the widget. We recommend using an image that is 350px by 350px.
Limitations
The Digital person image does not display before the session starts
There are no styling options at this stage
Greeting html element is not responsive when loaded on a mobile view
Supported browsers
PC- Chrome, Edge chromium, and Firefox
Mac- Chrome, Safari, and Firefox
Android - Chrome and Firefox
iOS - Chrome, Safari, and Firefox
Consideration when embedding into social media apps
Embedding into the following social media applications is supported on iOS: Messenger, Facebook, Instagram, and LinkedIn
None of the social media applications are supported on Android
FAQs
Can I customize my web component widget?
The only customizations currently supported are changing the profile picture and greeting message of the digital person widget.
Is the widget always going to be on the bottom right corner of the website?
Yes, currently the position of the widget is pre-determined. This is in our backlog to change in the future.
Does the widget work on mobile browsers?
Yes, the widget is designed to have a responsive view for both mobile and desktop browsers. However. the greeting message is not yet responsive for mobile devices. Currently, the mobile browser views are:
 |  |
What human OS platform Digital People are supported by the widget?
The widget supports Digital People on any HumanOS platform, however, the camera and mic decoupling functionality is only supported by Digital People that are Human OS2.0+.
How can I get a different view of the Digital Person other than the head and shoulders view?
The widget by default comes with a head and shoulders view (static camera cuts) to the Digital Person. It also supports the Cinematic Camera Cuts which are automatically toggled based on the conversation. The Responsive Camera Cuts are currently only appearing as static camera because of the lack of content cards. Once we’ve implemented the content cards, you would be able to select and see all three different types of cuts and their corresponding behavior in the widget frame.
Do I need to re-embed my code snippet from Studio, if I make any changes to my project?
No, any changes to the project within DDNA Studio should automatically reflect on the embedded widget as long as you “save” and “deploy” the project.
Do I need to understand the CMS or web platform requirements of a particular website / web app to see if the widget would work?
The Web Widget is a Soul Machines javascript tool that encapsulates our SMWebSDK in a web component wrapper. This technology works for any website that allows for code injections, iframes or HTML code snippets to be added to them. In the modern day, this would encompass majority of the websites developed today.
Contents
| Table of Contents |
|---|