Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section describes the requirements for using your custom UI for your Digital Person's conversational experiences.

Info

Note: A core assumption for this section is that you already have familiarity with building a UI and/or back-end Orchestration Server for your conversational experience. It also assumes that you have integrated our Web SDK into your website. If not, please refer to your technical kick-off our Web SDK documentation

Digital DNA Studio projects You may choose to use the Default UI or a Custom UI to host your Soul Machines Digital Person.

When the Custom UI is selected (Build my own), the project will be deployed as a video server with no default UI. You will need to create your If electing to build your own Custom UI you will need to create a website to display the digital person, using the WebSDK to establish a connection with the video server and display the digital person on the page.

A website that displays a digital person uses typical standard web technologies of like; HTML, CSS, and JavaScript. At this time, only websites developed as a Single Page Application (SPA) are supported, because the video stream cannot be kept active across page navigations.Building .

It is recommended that when building a custom UI is best done as a an SPA using a common web framework such as React, VUE, or Angular in addition to the Soul Machines WebSDK.

Available SDKs

Developer Documentation

Soul Machines provides detailed documentation on consuming our SDKs (webSDK, mobileSDK, and skillsSDK), connecting to our APIs, authentication, and walkthroughs. These documents will be continuously updated with environment schematics, sample code snippets, code libraries, guides, and other relevant developer resources.

Tip

The developer documentation hub can be found here: Soul Machines Developer Docs.