Run Voice Assistant with Realtime API

This guide will help you to run the Voice Assistant with Voice to Voice Realtime API in the NYRA-Agent Playground.

Prerequisites

Make sure you have the Nyra-Agent playground running. If it’s not already started, refer to the Run Playground guide to launch the playground.

Before proceeding, ensure you have the following information prepared:

  • Realtime API Key

  • RTC Information: Currently, only Agora RTC is supported. You can register for an account at Agora. We assume you have your App ID and App Certificate ready for configuration in your .env file.

Steps

To configure your Nyra-Agent, follow these steps:

  1. Open the Playground: Navigate to localhost:3000 to access the Nyra-Agent playground.

  2. Select Graph Type: Choose the voice_assistant_realtime graph type.

  3. Open Module Picker: Click on Module Picker to open the module selection menu.

  4. Choose V2V Module: Select your preferred V2V module from the dropdown list.

  5. Apply Module: Click Save Changes to apply the selected module to the graph.

  6. Open Property Configuration: Click the button next to the graph selection to open the property configuration.

  7. Configure Realtime API Key: In the property configuration, locate the Realtime API Key property and input the information you prepared.

  8. Save Changes: Click Save Changes to apply the configured property to the V2V module.

  9. Confirmation: If a success toast appears, the property has been successfully applied to the V2V module.

Now you’re all set! To interact with the Voice Assistant, click the Connect button. Please note, you may need to wait a few seconds for the agent to initialize before interaction begins.

Bind Weather Tool to your V2V

You can bind the weather tool to your V2V module in the Nyra-Agent Playground.

  1. Run the Agent: Ensure your Nyra-Agent is running.

  2. Open Module Picker: Access the Module Picker.

  3. Open Tool Selection: Click on the button next to the V2V module to open the tool selection menu.

  4. Select Weather Tool: From the popover list, choose the Weather Tool.

  5. Apply Tool: Click Save Changes to bind the weather tool to the V2V module.

  6. Confirmation: If a success toast appears, the tool has been successfully applied to the V2V module.

PreviousRun Voice AssistantNextRun Dify Chat Bot

Last updated