Skip to content
Guide & API

SessionSettings

Attributes

clientReferenceId

  • Type: string (optional)

A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.

metadata

  • Type: object (optional)

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

requestedData

Describes what data the avatar has to collect. This is a task for the avatar.

initialPhrase

  • Type: string (optional)

If specified, the avatar will start the conversation with the phrase.

finalPhrase

  • Type: string (optional)

If specified, the avatar will end the conversation with the phrase.

providedData

  • Type: object

There is the ability to pass known data about the user that AI can use during the conversation. for example:

{
  "userName": "John Smith"
}