Note: The Studio offers additional settings beyond what is available through the API and referenced in these docs. We recommend configuring your avatar fully in the Moonscale Studio before creating rooms via the API, as this gives you access to the complete set of configuration options.
Getting your liveAvatarId
Navigate to app.moonscale.com and select the avatar you want to use. Make sure that the avatar’s Active toggle is enabled. In the URL, you will see the liveAvatarId attached. The URL follows the following format:https://app.moonscale.com/real-time-avatars/your-live-avatar-id, where the liveAvatarId is in uuid format.
General Settings
These settings define the avatar’s identity and visibility.boolean
Toggle this to make the avatar publicly accessible for starting conversations.
string
The display name shown in the Studio and shared meeting links.
string
Optional internal description for your team to identify the avatar’s use case or role.
Transcripts
Control how conversation history is stored and anonymized.boolean
When enabled, conversations with this avatar will be saved and accessible from the dashboard.
boolean
If enabled, personal identifiers in stored transcripts will be automatically anonymized.
AI Configuration
This section controls which avatar you’re assigning, its voice, and lead enrichment settings.string
required
Choose an Avatar to visually represent your assistant. You can select from existing trained avatars in your workspace.
string
required
Select the voice profile your avatar will use during conversations.
boolean
When enabled, this will automatically enrich lead data with additional information when contact details are collected.
string
The lead qualification method that will be used for the live avatar.
Prompt Configuration
This section controls the instructions and behavior of your AI avatar. You can configure the system prompt, guardrails, knowledge base, and contact collection settings via the Instructions tab in the Studio.string
required
Core instructions that define the AI’s behavior. This is required and defines the avatar’s personality, goals, and how it should interact with users.
boolean
Safety guidelines and restrictions. When enabled, you can configure rules that constrain the avatar’s responses to stay within defined boundaries.
boolean
Guidelines for using knowledge base information. When enabled, the avatar can reference uploaded knowledge documents during conversations.
boolean
Instructions for collecting contact information. When enabled, you can configure how and when the avatar gathers user details.
Conversation Settings
Define how the avatar interacts during meetings. The Studio offers more granular control over conversation settings than what is available through the API. If you need advanced configuration, set up your avatars directly via the Moonscale Studio.boolean
Lets the user choose to show or hide their camera in live rooms. If disabled, the Camera Toggle button will not appear in the UI.
number
Sets the maximum length (in minutes) for each call. The session will automatically end after this time elapses.
string
Specifies the language used for input and output. This affects transcription accuracy and the avatar’s spoken responses.
string
The avatar’s first message when a user joins the room. This is displayed in the chat and optionally spoken aloud.
boolean
Enabling this will require the user to share their contact details (name and email) in order to start a conversation with this avatar.
Capabilities
Enhance your avatar’s functionality with real-time tools.boolean
Allows the avatar to hold free-form, natural language conversations with participants.
boolean
Grants the avatar the ability to fetch and respond with real-time web search results.
Note: Additional capabilities such as document summarization or third-party tool integrations are coming soon.