API
Digital Human Configuration

Create a Digital Human

8min

To create a digital human you will need a user and organisation. Depending on your organization's type and privileges, you will have access to various head visuals. See User for more information.

Components

All Digital Humans are made up of the following required components:

  • Name
  • Alias
  • Face
  • Voice
  • Operating Mode

Prior to starting the creation process, it is important to consider what operating mode your Digital Human should use. This is directly related to the intended use case.

Operating Modes

Digital Humans can operate in 5 distinct modes

  • Text-to-Video: Specify text for a given Digital Human, and a video will be generated with the digital human speaking the text. The output is an mp4.
  • Open Conversation: Configure a prompt for a given Digital Human, and the Digital Human will be conversational. The output is a hosted, conversational Digital Human.
  • Restricted Open Conversation: Provide content and configure a prompt, and the Digital Human will be conversational about the content provided. The output is a hosted, conversational Digital Human.
  • Guided Conversation: Build a workflow, and the Digital Human will be able to guide you through the conversational workflow. The output is a hosted, conversational Digital Human
  • Plugin mode: Leverage a webhook to connect any custom conversational engine or LLM to power the conversation of the Digital Human. The output is a hosted, conversational digital human .

Text-to-Video operating mode is only recommended for testing purposes. The Digital Human will be available to review how it speaks the text you provide it, in real-time. Text-To-Video is a feature available across all Operation Modes. See Generate a Digital Human Video.

Digital Human Creation Process

All digital humans need an existing head visual and voice. To see your available head visuals, see List Faces and List Voices documentation.

Names and aliases are free text fields which are used for personalization. There are no restictions apart from being required fields.

Use the POST /head/create- to create Digital Humans. Each operation mode requires a different request body (see Operating Mode Parameters).

doc_qa
ttt
oc
voiceflow
plugin


The payload can contain many additional properties of the Digital Human as described in the Configuration Parameters page.

If you have access to multiple organsations, you will need to add "orgId":"<orgId>" to the payload.

Example requests

Curl


Doc_qa Digital Humans need an additional step to be functional. This is described in Create a doc_qa Digital Human and related to uploading a knowledge document.

Interact with a Digital Human

Upon creating a Digital Human with a single call to the head/create endpoint, your Digital Human is now hosted by unith at chat.unith.ai/<generatedPath>

This path can be found in the POST head/create response, or in the GET head/{ID} response:

Public URL


Embed a Digital Human in your application

Updated 20 Sep 2024
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?