Instructional Video: https://www.loom.com/share/00841aa1e7b04df7bbbb3a58e66900a1?sid=b8c0f853-aaee-4c9d-9693-73e68fb69f23
- Add the plugin to your project
- Set the VAPI_PUBLIC_KEY in the Plugin settings, find this in the API keys section in your Vapi dashboard.
- Set the VAPI_ASSISTANT_ID in the Plugin settings, find this in the assistant page in Vapi.
- Start setting your up your events, action and workflows using our vapi element.

## Documentation for VAPI Plugin

Hey there! This is a walkthrough of the VAPI plugin, designed to provide smart audio assistance for your app. Let's dive into how you can utilize this feature effectively.

### Overview

Elements:

-The primary element for this plugin is Vapi (Testing), accessible within the Design tab. This is the core element for testing Vapi's functionalities.
Data Call Functionality

Assistant Calls (Testing) - List Assistants:

-Use this data call to retrieve a list of assistants. Input your private and public keys to access data via the get data from external API function, which enables real-time retrieval and display of assistant data.
Dynamic Dropdowns

-Implement dropdown menus that dynamically populate with assistant data by linking values to specific assistant IDs. This allows users to select from available assistants seamlessly.
Events and Actions

Events:

-A Vapi (Testing) VAPI Call Starts: Triggers at the beginning of a Vapi call.

-A Vapi (Testing) VAPI Call Ends: Triggers upon call completion.

-A Vapi (Testing) VAPI Is Reset: Resets the Vapi call environment, preparing it for a fresh session.

Actions:

-VAPI_INIT_CALL (Testing): Initializes a new call with the Vapi plugin.

-VAPI_END_CALL (Testing): Ends an ongoing call.

-VAPI_RESET_VAPI (Testing): Resets all Vapi parameters and settings.

-VAPI_GET_ASSISTANT (Testing): Retrieves details of a specific assistant.

-VAPI_LIST_ASSISTANTS (Testing): Lists all available assistants.

-VAPI_CREATE_ASSISTANT (Testing): Creates a new assistant with specified parameters.

Input Sections

-Key fields for configuring Vapi involve inputting private and public keys. These elements serve as access credentials for retrieving and manipulating assistant data within the platform.

Dynamic Variables

-Use dynamic variables to personalize conversations and interactions. Insert data-specific keywords within curly brackets {} to include dynamic, real-time information during assistant interactions.
Assistant Creation

Creating a New Assistant:

-Use the creation interface to set up new assistants. Specify parameters such as assistant name, language preference, and LLM options. To finalize setup, either save as data or use VAPI_GET_ASSISTANT to fetch the assistant ID.
Transcriber Providers and Models

-Conditional settings allow you to select transcription models based on chosen providers, adapting transcription functionality as needed.
Call Control


Final Notes

For additional support, connect with the team via Discord.
Stay updated with new features and enhancements as they are added to the Vapi plugin for improved functionality.

Discord: https://discord.com/invite/fnMfNZY3tR