Skip to main content
At the heart of the OpenHome ecosystem are Agents—customizable AI voice characters designed for specific tasks and applications. Each Agent is characterized by several key attributes, including:
  • Description and Purpose: Defines the Agent’s role and how it behaves within the chosen LLM.
  • Voice: You can tailor the voice to best represent the Agent, aligning with your preferences or project needs.
  • Dynamic Feedback: Agents evolve based on user interactions, learning from conversations to provide more personalized responses over time. OpenHome’s DynamicAgentConstructor enables Agents to evolve with every conversation. They adapt to your conversation history, preferences, and personal style, creating an ever-improving interaction experience. This ensures that the conversation isn’t just accurate but also deeply personalized, making every interaction feel more intuitive.

​
How Agents Work

The core architecture revolves around three key modules: STT Transcription (Speech-to-Text), TTT Processing (Text-to-Text), and Voice TTS (Text-to-Speech). These modules work together to create rich, adaptive experiences powered by customizable “Agents”.

​
Workflow

  1. Speech Input: The system listens for voice commands, initiated by a cold start message.
  2. STT Transcription: The Speech-to-Text (STT) module converts speech into text.
  3. LLM Processing: The transcribed text is processed by the designated LLM (the “brains” of the assistant, the large language model), which generates a relevant response based on the user’s input and conversation history. OpenHome supports over 20 different LLMs.
  4. TTS Synthesis: Once a response is generated, it’s converted back into speech using customizable voices, creating a natural, interactive experience. This module brings the conversation to life with fluent, human-like speech.

​
How to Create & Manage Agents

The Agents dashboard allows you to view, manage, and create custom AI Agents. You can also customize the interaction experience by adding new voices. agents_page

​
Creating New Agent

To get started, visit the Agents dashboard, and select the Create Button button at the top right of the page and input the following information:

​
Agent Information

add_personality_form

— Name: Enter the name of your Agent (We suggest something unique and identifiable). This is the name that will be used to identify your Agent in the dashboard and marketplace. Note that your Agent will be aware of this name as an identifier.
  • Marketplace Information: Write a concise, engaging summary to highlight your Agent in the marketplace. This will not impact Agent behavior and is intended for informational purposes only.
  • Image: Upload an image to represent this Agent. This image will be used in the marketplace to represent your Agent.
  • Key Features: List the unique abilities or functions the Agent is equipped with. These features provide insight into what the Agent can do, such as specific commands or tasks it is optimized for.
    Note: These tags are for labeling use. It does not inject any additional context into your Agent.

​
Agent Behavior

add_personality_form

  • Starting Message: Agents can optionally be configured with an opening message or greeting. This first message will be spoken by your Agent when you first start a new conversation. Certain use cases require a first message, while others do not.
  • Agent Templates: Choose a template to use a pre-defined purpose and description prompts for your Agent. Available templates include:

  • Description Prompt: The description serves as the first System Prompt for your Agent. It is the first prompt in the message list fed to the LLM, and it sets the foundation for how the Agent behaves. Use the description to define the context, role, traits, and specific instructions, shaping the way the Agent responds and interacts.
  • Purpose Prompt: Specify the Agent’s intended role or function, further refining your description. By adding additional context, you help the LLM understand the job or role associated with the Agent, ensuring it behaves in a more accurate and relevant way based on its function. When creating a prompt, the AI-generated button save_button helps refine your prompt by suggesting improvements for clarity and detail. It guides you in crafting precise, focused prompts to enhance the AI’s response.
  • Disable prompt modification: Enabling this option will prevent OpenHome Builders from making any modifications to your Agent’s prompt.

​
Pick a Voice

add_personality_form

  • Language: Select the language the Agent will use for communication. This setting determines the language in which the Agent will respond. You can interact with your Agent in any of the supported languages, and it will respond in the language selected.
  • Voice Identity: Select a voice from the list to determine how the Agent will sound. Use a pre-installed voice or add your own Voice ID.
    Note: Optionally, test the voice before finalizing it. save_button
  • Gender: Choose the gender identity for the Agent. This helps customize how the AI agent interacts, particularly if the voice or tone needs to reflect specific characteristics.
Once the required fields are filled:
  • Select the save_button button to finalize and create the new Agent.
  • If you change your mind, select the cancel_button button to discard the process.

​
Managing Agents

The Agents page allows you to view, manage, and organize all the Agents you have created or installed from the Marketplace. Each Agent is displayed as a card, showing key details such as its description, last updated timestamp, and options for further customization or interaction.

alan_watts

  • Search: Use the search bar at the top to quickly find a specific Agent by name.

search_bar

  • Status Filter: The dropdown menu in the top right allows you to filter Agents by status, including Published, Unpublished, Default, and Installed.

listings

  • play_icon Start Conversation: Open a conversation with the selected Agent.
  • share_icon Share: Share this Agent with someone, allowing them to interact with it.
  • edit_icon Edit:Click the Edit button to modify your Agent.
  • delete_icon Delete: Delete any created or installed Agents.
  • rating_and_review Ratings & Review: Review and rate the Agent on the marketplace.

​
Adding a New Voice

To add your own custom voice, visit the Agents dashboard, and select the add_new_voice_id_buttonbutton at the top right of the page and input the following information:
  • Name: Enter the name of the new voice you want to create. This helps identify the voice within your list of options.
  • Description: Provide a brief description of the voice, including details like its tone, accent, or intended use. This helps others understand what the voice is designed for when interacting with it.
  • Voice ID: Input the Voice ID provided by your chosen TTS (Text-to-Speech) provider. This ID links the voice you’ve uploaded to the provider.
  • Select save_button to finalize and add the new voice.
  • If you change your mind, select cancel_button to discard your voice.

add_new_voice_id_form

​
Uploading Your Voice

  • Generating a Voice ID: Before adding a new voice in OpenHome, you’ll need to upload your custom voice to your preferred TTS provider (e.g., Eleven Labs). Once uploaded, you’ll receive a Voice ID from the provider, which you can enter in the Voice ID field here.
  • Updating API Key: Ensure your API key for the TTS provider is up to date. This key is necessary for OpenHome to communicate with the TTS service and use your custom voice for Agents. You can update or manage your API key in the API Keys settings section.