> ## Documentation Index
> Fetch the complete documentation index at: https://docs.openhome.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Welcome to the OpenHome Dashboard! This guide will walk you through the essential steps to get started with your OpenHome experience.

## Accessing the OpenHome Dashboard

### Login

* Go to the OpenHome Dashboard.
* Enter your Email and Password.
* Click `Log in` to access your account.
* Alternatively, you can sign in using Google or Apple by clicking `Sign in with Google` or `Sign in with Apple`.
  <img src="https://mintcdn.com/algoryc/D9AXODcK97nPG6O5/openhome_icons/dashboard_images/login.png?fit=max&auto=format&n=D9AXODcK97nPG6O5&q=85&s=f37f0e989340dd46ed3c32a21826845e" alt="OpenHome Login Page" width="670" height="723" data-path="openhome_icons/dashboard_images/login.png" />

### New User Registration

* If you're new to OpenHome, click `Don't have any account?` to open the signup form, where you can create a new account.
* You can also sign up using Google or Apple by clicking `Sign up with Google` or `Sign up with Apple`.
  <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_images/signup.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=84f4ca95bfa89f531aefa61f5646b23c" alt="OpenHome Signup Page" width="884" height="751" data-path="openhome_icons/dashboard_images/signup.png" />

## Navigating the Home Page

### Home Dashboard Overview

* **Abilities:** Access default Abilities provided by OpenHome.
* **Agents:** View and manage pre-installed agents.
* **Marketplace:** Browse additional agents and Abilities.

### Using the Dashboard

#### Start Conversation

To start a conversation, simply navigate to the left sidebar and select one of the available agents under "My Conversations." Just click on the agent you'd like to interact with, and you'll be ready to engage in a dynamic and personalized chat.

* **Start Conversation:** The conversation will start automatically, ensuring enhance user experience. If you wish to end the conversation, simply click the orange button to stop. To start a new conversation, click the green button and continue the interaction.
* **Audio & Mic:** Use the left sky blue button to turn off speaker and right sky blue button to mute your mic.
* **Interrupt:** The interrupt button allows manual interruptions.
* **Conversation Modes:** Switch to audio-based conversations by toggling the mode button to "on." Text mode is the default, but feel free to choose audio anytime for a more dynamic experience.
* **History:** Review your conversation history displayed in the center.
* **Settings:** The profile can be found in the lower-left corner. To configure the SDK settings, simply navigate to "Settings."

<img src="https://mintcdn.com/algoryc/D9AXODcK97nPG6O5/openhome_icons/dashboard_icons/start_a_conversation.png?fit=max&auto=format&n=D9AXODcK97nPG6O5&q=85&s=d0cd178db3a986ce5a56cc98dd10f845" alt="OpenHome Conversation" width="1920" height="1011" data-path="openhome_icons/dashboard_icons/start_a_conversation.png" />

#### Agent Settings

The Agent Settings panel, located on the right side of the conversation window, offers you the flexibility to adjust and fine-tune agent-related preferences. It includes options for Conversation, Behavior, and Identity Controls.

* **Conversation Settings:** Use these controls to manage how conversations behave in real time:
  * **Interactive Interruption:** Lets you interrupt the agent while it is responding.
  * **Auto Interruption:** Automatically handles interruptions based on interaction cues.
  * **Alerts:** Turns conversation-related notifications on or off.
  * **Interrupt Sensitivity:** Adjusts how easily interruptions are triggered.

<p align="center">
  <img src="https://mintcdn.com/algoryc/bqakoKn6kkXdGktl/openhome_icons/dashboard_icons/conversation_settings.png?fit=max&auto=format&n=bqakoKn6kkXdGktl&q=85&s=de3ed9632da0c60f49ccf06cf8323325" alt="conversation_settings" width="377" height="285" data-path="openhome_icons/dashboard_icons/conversation_settings.png" />
</p>

* **Behavior Controls:** Customize the greeting by crafting a personalized **Starting Message**, define agent traits through a **Descriptive Prompt**, and establish the role of the agent with a clear **Purpose Prompt**.

<p align="center">
  <img src="https://mintcdn.com/algoryc/DHf_m0ZL8j38qpe6/openhome_icons/dashboard_icons/behaviour_control.png?fit=max&auto=format&n=DHf_m0ZL8j38qpe6&q=85&s=a54334e9e0294856a8a69da1d6db09b6" alt="behaviour_control" width="372" height="328" data-path="openhome_icons/dashboard_icons/behaviour_control.png" />
</p>

* **Identity Controls:** Select the voice and language based on your agent preferences to create a more personalized and engaging experience.

<p align="center">
  <img src="https://mintcdn.com/algoryc/DHf_m0ZL8j38qpe6/openhome_icons/dashboard_icons/identity_controls.png?fit=max&auto=format&n=DHf_m0ZL8j38qpe6&q=85&s=72578ccd9422f5139ce0cca54bdbd7d9" alt="identity_controls" width="371" height="251" data-path="openhome_icons/dashboard_icons/identity_controls.png" />
</p>

## Agents Page

The Agents page allows you to view, manage, and create custom AI agents. You can also add new voices to customize the interaction experience further.

### Managing Agents

* **Search:** Use the search bar to find specific agents quickly.
* **Edit or Delete:** Use the icons below the agent name to edit or delete them.

### Create New Agent

* In the left sidebar, click on "Create" and choose "Agent Personality" to get started.
* You will see three creation options:

<Tabs>
  <Tab title="Quick Creation">
    - **Quick Creation** is a fast setup path with minimal inputs.
    - Complete these fields:
      * **Avatar**: Upload an avatar or click **Generate with AI** to create one.
      * **Name**: Enter the personality name.
      * **Starting Message**: Set the default greeting shown/spoken at conversation start.
      * **Description**: Add the core behavior prompt that defines how the personality responds.
      * **Personality Category**: Choose the primary category (for example, Education, Companion, Home, Famous People, Games, Role Play).
      * **Voice Identity**: Select a voice, optionally use **Clone voice**, and preview it with the play button.
      * **Switch to PRO Mode**: Move to the full editor if you need advanced settings.
      * **Save Personality**: Create the personality with the current quick setup values.

    <p align="center">
      <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/agent_quick_creation.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=61508a0fcc96c422751b187fbd00df7e" alt="agent_quick_creation" width="807" height="855" data-path="openhome_icons/dashboard_icons/agent_quick_creation.png" />
    </p>
  </Tab>

  <Tab title="Create Your AI Twin">
    * **Create Your AI Twin** lets you create a twin with guided setup.
    * Set a **Personality Image** using **Gallery**, **Camera**, or **Generate with AI**.
    * Enter **Personality Name**, choose **Language**, and choose **Gender**.
    * Click **Next** to start initialization.
    * The system shows an **Initializing Twin Creation...** status while your twin is being prepared.
    * Once initialized, you can:
      * Click **Call** for voice interaction.
      * Click **Message** to send text messages.
      * Click **Stop** to end the current conversation.

    <p align="center">
      <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/ai_twin_creation.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=518d6a1028edda70fdb26a19416aa90b" alt="ai_twin_creation" width="566" height="719" data-path="openhome_icons/dashboard_icons/ai_twin_creation.png" />
    </p>
  </Tab>

  <Tab title="Pro Creation">
    * **Pro Creation** gives complete control over personality configuration.

    * You can click the **Quick Creation** button at the top-right to switch back to the quick setup screen.

    * Configure these 4 sections:

      * **Personality Information**:
        * **Name**: Enter a unique, identifiable name that appears in the dashboard and marketplace.
        * **Marketplace Information**: Add a brief summary for marketplace display; this does not affect model behavior.
        * **Avatar**: Upload an image to represent your personality, or click **Generate with AI**.
        * **Key Tags**: Add categorization tags (for example, `Male`, `Anime`) to help organize discoverability.

          <p align="center">
            <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/personality-information.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=c19ab02b147170b732f9d18b8fde5668" alt="personality_information" width="1632" height="572" data-path="openhome_icons/dashboard_icons/personality-information.png" />
          </p>

      * **Personality Behavior**:
        * **Starting Message**: Initial greeting or cold-start message spoken when a conversation starts.
        * **Description**: Foundation prompt that defines behavior, traits, and interaction style.
        * **Prompt Modification**: Toggle whether OpenHome Builder can modify prompts for user interaction flow.
        * **Publish Personality**: Toggle whether this personality is published to the marketplace.
        * **Personality Category**: Choose one or more categories (for example, Education, Companion, Home, Famous People, Games, Role Play).
        * **Base Ability**: Select a default Ability that auto-triggers on call initialization using **Choose Default Ability**.

          <p align="center">
            <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/personality-behaviour.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=41750647942fae53afa89e1769395210" alt="personality_behavior" width="1641" height="602" data-path="openhome_icons/dashboard_icons/personality-behaviour.png" />
          </p>

      * **Personality Identity**:
        * **Language**: Select the language the Personality will use for communication during interactions.
        * **Voice Identity**: Select a voice or add a custom Voice ID to define how the Personality sounds; you can also use **Clone voice** and preview with the play button.
        * **Gender**: Choose the gender identity to shape the interaction style of the Personality.

          <p align="center">
            <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/pick-voice.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=44856bc6f04ed4db38262e7da797e72b" alt="pick_a_voice" width="1641" height="576" data-path="openhome_icons/dashboard_icons/pick-voice.png" />
          </p>

      * **Personality Platforms & Models**:
        * **Speech-to-Text Platform**: Choose the transcription provider.
        * **Speech-to-Text Model**: Choose the model for the selected STT platform.
        * **Text-to-Speech Platform**: Choose the voice synthesis provider.
        * **Text-to-Speech Model**: Choose the model for the selected TTS platform.
        * **Text-to-Text Platform**: Choose the LLM provider.
        * **Text-to-Text Model**: Choose the model for the selected TTT platform.
        * **Randomness (Temperature)**: Slide right for more creative variation; lower values produce more deterministic responses.

          <p align="center">
            <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/platforms-models.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=dd11f023c28be8db6f8f7da5bc370664" alt="platforms_models" width="1653" height="634" data-path="openhome_icons/dashboard_icons/platforms-models.png" />
          </p>

    * After completing all 4 sections, click `Save Personality` to create the personality.
  </Tab>
</Tabs>

## Abilities Page

The Abilities page allows you to manage and customize the functionalities available in OpenHome. You can view installed Abilities, add new ones, and configure trigger words.

### Managing Abilities

* **Tabs:**
  * **My Abilities:** View all custom Abilities you have created.
  * **Published Abilities:** View all custom Abilities you have published.
  * **Installed Abilities:** Manage all installed Abilities.
  * **Add Custom Ability:** Upload a .zip file containing your code to create a custom ability.
  * **Live Editor:** Enhance your created ability by utilizing the live editor for real-time modifications and improvements.

### Ability Controls

* **Enabled:** Turn the Ability on or off.
* **Agent/System Ability:** Choose whether the Ability runs as an Agent Ability or a System Ability. Enable only one of them based on your use case.
* **Trigger Words:** Use **ADD +** to add trigger phrases and use the `x` on each tag to remove them.
* **Last Updated:** View the latest update timestamp at the bottom of the Ability card.
  <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/Ability_controls.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=33338c41c00d4bd66188112df0142027" alt="Abilities page" width="477" height="405" data-path="openhome_icons/dashboard_icons/Ability_controls.png" />

### Add New Ability

* In the left sidebar, click on "Create" and choose "Agent Ability" to get started.
* **Ability Information:** Enter the basic details for your Ability:
  * **Name**: Add a unique, identifiable Ability name that appears in the dashboard and marketplace.
  * **Description**: Write a short summary to describe what the Ability does.
  * **Image**: Upload an image to represent the Ability in the dashboard and marketplace.

<p align="center">
  <img src="https://mintcdn.com/algoryc/HzI1I7HRNeMurqUx/openhome_icons/dashboard_icons/ability_information.png?fit=max&auto=format&n=HzI1I7HRNeMurqUx&q=85&s=01a1b08cad7d964c0f752b9aba3e2c24" alt="ability information" width="1643" height="686" data-path="openhome_icons/dashboard_icons/ability_information.png" />
</p>

* **Ability Behavior:** Configure how the Ability works:
  * **Category**: Choose how the Ability behaves (for example, `Skill`, `Agent Controlled`, `Background Daemon`, or `Local`).
  * **Template**: Pick a built-in template card, or click `Upload Custom Ability` to upload your custom Ability package.
  * **API Keys**: Add required third-party keys by entering a key name and provider link, then click `+ Add`. Set key values later in **Settings > API Keys**.
  * **Trigger Words**: Add trigger words/phrases that activate the Ability during conversations.

<p align="center">
  <img src="https://mintcdn.com/algoryc/S-vOB0wvZIBaQK-q/openhome_icons/dashboard_images/agent_controlled_updated_sc.png?fit=max&auto=format&n=S-vOB0wvZIBaQK-q&q=85&s=ad0e1a8f6d1eac7a2364f97f498a1e1e" alt="ability behavior" style={{ borderRadius: "12px" }} width="1918" height="891" data-path="openhome_icons/dashboard_images/agent_controlled_updated_sc.png" />
</p>

#### Finalizing

* Click `Save Ability` to add the new Ability.

## Marketplace

The Marketplace lets you discover and use Personalities, Abilities, and Voices.

### Personalities, Abilities, and Voices Tabs

* Use the top tabs to switch between **Personalities**, **Abilities**, and **Voices**.
* Use the search bar to find personalities and abilities quickly.
* In **Personalities**, you can open cards, use `Read More`, start with `Call`, filter by categories, and use `Show More` / `Show Less`.

### Featured Abilities and Voices

* **Featured Abilities** shows curated ability cards with actions like `Try It` and `Uninstall`.
* The **Voices** section provides two tabs: **OpenHome Voices** and **User Voices**.
* Each voice card includes tags and a play button to preview the voice.

### Newly Added

* The **Newly Added** area has separate rows for **Personalities** and **Abilities**.
* Each row supports search, `Find`, and sorting (for example, `Newest`).
* Use the add card (`+`) to create a new Personality or Ability from that row.

### Template Abilities

* **Built-In:** These are default templates for built-in capabilities.

#### Try Template Abilities

Click the `try it` button. A pop-up will appear where you should enter the name provided next to "Creating Template Capability."

<p align="center">
  <img src="https://mintcdn.com/algoryc/D9AXODcK97nPG6O5/openhome_icons/dashboard_icons/templates_ability.png?fit=max&auto=format&n=D9AXODcK97nPG6O5&q=85&s=17b0f00f096acb5a1fe3585f908d0702" alt="templates ability" width="762" height="315" data-path="openhome_icons/dashboard_icons/templates_ability.png" />
</p>

After confirming, you will be redirected to the live editor, where you can either make changes or proceed without making any adjustments.

<p align="center">
  <img src="https://mintcdn.com/algoryc/DHf_m0ZL8j38qpe6/openhome_icons/dashboard_icons/live_editor.png?fit=max&auto=format&n=DHf_m0ZL8j38qpe6&q=85&s=1c3fcd0f43a6b61cd76adc1194c43137" alt="templates ability" width="1920" height="1011" data-path="openhome_icons/dashboard_icons/live_editor.png" />
</p>

**Modify Files:** You can create, delete or modify files easily.

<p align="center">
  <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/live_editor_optons.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=e6f2d96599c9ce871b9910cd2d28e56f" alt="templates ability" width="320" height="339" data-path="openhome_icons/dashboard_icons/live_editor_optons.png" />
</p>

**Trigger keywords:** Trigger keywords can be checked using this button <img src="https://mintcdn.com/algoryc/nIjKmDT8_yYOKqOt/openhome_icons/dashboard_icons/trigeer_button.png?fit=max&auto=format&n=nIjKmDT8_yYOKqOt&q=85&s=e0f736a61a0101e9feece340c3035d9e" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} width="38" height="35" data-path="openhome_icons/dashboard_icons/trigeer_button.png" />

You can also click on edit button in <img src="https://mintcdn.com/algoryc/nIjKmDT8_yYOKqOt/openhome_icons/dashboard_icons/trigger_detail.png?fit=max&auto=format&n=nIjKmDT8_yYOKqOt&q=85&s=6dc60f84419994bcf4d0d2c4542bb66c" alt="play_icon" width="100" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/trigger_detail.png" /> to modify, add, or remove trigger keywords.

<p align="center">
  <img src="https://mintcdn.com/algoryc/D9AXODcK97nPG6O5/openhome_icons/dashboard_icons/trigger_words_modify.png?fit=max&auto=format&n=D9AXODcK97nPG6O5&q=85&s=22d2e76e2bfd61611f1ca561986a857a" alt="templates ability" width="737" height="267" data-path="openhome_icons/dashboard_icons/trigger_words_modify.png" />
</p>

**Editor Options:**

* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_commit.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=ffd5d7e4bef848e572d49e8f20c58026" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_commit.png" /> **Commit**: Commit you changes as a new release.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_discard.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=9aeeaeb63fbdc898e160933182b240bd" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_discard.png" /> **Discard Changes**: Discard your current changes.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_save.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=7c1b16fbc6ea29e70cf09e0255c11ec6" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_save.png" /> **Save Changes**: Save your current changes.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_revert.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=266823a3d96e85e26201fee4d9e8985e" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_revert.png" /> **Revert**: Revert your changes to initial release.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_download.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=388cef55fc89453fd79c369d102d06cc" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_download.png" /> **Download Folder**: Download the ability code as a zip folder in.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/esitor_live_test.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=2072e5035886a9e7864ebc1c41c6c0ba" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/esitor_live_test.png" /> **Start Live Test**: Test your changes live here.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_mic.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=c7699408480a122d5f18695f1a164441" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_mic.png" /> **Mic**: Turn on/off microphone.
* <img src="https://mintcdn.com/algoryc/GGeODhG37dHsQeAa/openhome_icons/dashboard_icons/editor_speaker.png?fit=max&auto=format&n=GGeODhG37dHsQeAa&q=85&s=894d3ba5f1bb6916dea050adc384f217" alt="play_icon" width="60" height="30" style={{ display: 'inline-block', marginRight: '8px', verticalAlign: 'middle' }} data-path="openhome_icons/dashboard_icons/editor_speaker.png" /> **Speaker**: Turn on/off speaker.
