Embed Digital Humans in your Application
UNITH Digital Humans are platform agnostic. The following guidelines enable Digital Humans to be seamlessly integrated into various digital applications, from mobile apps to web apps.
You will need:
- Organisation name.
- Digital Human head name.
- (Optional) Localization and image repos - request more information from UNITH customer success team.
You should be able to access your organisation and digital human using GET /user/me. If you don't have access to the Digital Human platform please refer to User
Include the following code snippet in your website or application. These are the basic elements required to place digital humans in your page, but some additional code could be needed.
The following configuration options are available to provide added controls and customisation options. These can be added inside the talking-head element.
- data-api_base: the server you will connect to.
- data-api_key: your api key (required)
- data-embed: if set to something other "1" or "true", you will be able to access the full UI (default is true)
- data-org_id: your organisation's friendly name, as shown in the PublicURL (required)
- data-head_id: the head name of your Digital Human (required)
- data-theme: light or dark theme (default is light)
- data-font: a font of your choice. Note: you will need to have this font available in your current frontend. (default is Nunito)
- data-time_pressure: choose if you wish to show the counter timer to the user.
- data-message_feedback: Display thumbs up/down for each message coming from the Digital Human. User can click on it, and we will receive their feedback. (default is false)
- data-mic_enabled: If set to something other than "1" or "true", the UI will not use speech recognition. No mic permissions will be needed from the user (default is true)
- data-subs_enabled: If set to something other than "1" or "true", the UI will not display subtitles. (default is true)
- data-touch_to_start_icon(optional): URL of an icon that will replace the default touch to start icon
- data-language(optional): overrides the language configuration in your Digital Human for UI elements (default is en-US). If you need a language we do not support, contact us.
id="talking-head" is not optional and the digital human won't work if removed.
Leverage CSS as needed to customize embedded element. The below acts as a guideline:
If you are interested in hosting the required assets in your own servers, you could access the public bucket located in embedded.unith.ai to download all the necessary dependencies.
The following files can be found there:
