Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions docs/lovable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,26 @@ import { IntegrationHeader } from '/snippets/integration-header.mdx'
partnerHeight="32px"
/>

[Lovable](https://lovable.dev/) is an AI-powered platform that lets anyone, regardless of technical skill, build full-stack web applications using natural language. Just describe what you want, and Lovable builds it for you.
<video
controls
loop
playsInline
className="w-full aspect-video"
src="/images/lovable-demo.mp4"
/>

With Rime's text-to-speech integration, you can now add natural, lifelike voice capabilities to your Lovable apps with just a few lines in your prompt. Whether you're building a voiceover tool, an accessibility feature, or an AI assistant, getting Rime TTS into your Lovable project is surprisingly simple.
[Lovable](https://lovable.dev/) is an AI-powered platform that lets anyone, regardless of technical skill, build full-stack web applications using natural language. Just describe what you want, and Lovable builds it for you.

## How It Works
With Rime's text-to-speech (TTS) integration, you can now add natural, lifelike voice capabilities to your Lovable apps with just a few lines in your prompt. Whether you're building a voiceover tool, an accessibility feature, or an AI assistant, getting Rime TTS into your Lovable project is surprisingly simple.

Since Rime's API requires authentication, Lovable handles this securely through [Lovable Cloud](https://docs.lovable.dev/integrations/cloud). Your API key gets stored as a secret and accessed through Edge Functions, so it's never exposed in your frontend code.
## Prerequisites

Here's how to get started:
- A [Lovable](https://lovable.dev/) account
- A Rime [API key](https://app.rime.ai/tokens)

**Step 1:** Grab your Rime API key from [app.rime.ai/tokens](https://app.rime.ai/tokens/)
## Step 1: Prompt Lovable to use Rime

**Step 2:** In your Lovable prompt, explicitly tell it to use Rime as the TTS provider. Include the API details so Lovable knows exactly how to wire things up:
In your Lovable prompt, explicitly tell it to use Rime as the TTS provider. Include the API details, so Lovable knows exactly how to wire things up:

```
Use Rime TTS
Expand All @@ -33,11 +40,15 @@ Use Rime TTS
Store the API key in Lovable Cloud.
```

**Step 3:** When Lovable prompts you to enable Cloud and add a secret, paste in your Rime API key. That's it, Lovable handles the rest.
## Step 2: Add your Rime API key

For a deeper understanding of how Lovable manages authenticated APIs, check out their [integration docs](https://docs.lovable.dev/integrations/introduction#authenticated-apis-requires-secrets).
Since the Rime API requires authentication, Lovable will prompt you to enable [Lovable Cloud](https://docs.lovable.dev/integrations/cloud) and add your Rime API key under **Cloud → Secrets**.

## Try It Yourself
That's it! Lovable handles the rest by saving your API key as a secret and accessing it through Edge Functions, so it's never exposed in your frontend code.

For a deeper understanding of how Lovable manages authenticated APIs, check out the [Integrations](https://docs.lovable.dev/integrations/introduction#authenticated-apis-requires-secrets) docs.

## Try it yourself

Here's a real prompt you can paste into Lovable to build a voiceover studio app:

Expand Down Expand Up @@ -72,13 +83,15 @@ Use Rime TTS
Store the API key in Lovable Cloud.
```

Feel free to tweak the design, swap out voices, or completely reimagine the app. The key is including those Rime TTS instructions so Lovable knows how to connect everything.
Feel free to tweak the design, swap out voices, or completely reimagine the app. The key is including those Rime TTS instructions, so Lovable knows how to connect everything.

**Test the app built by this prompt:** Visit [rime.lovable.app](https://rime.lovable.app).

**See what this prompt builds:** [rime.lovable.app](https://rime.lovable.app)
## Tips for better results

## Tips for Better Results
Follow these recommendations to improve your results:

- Be specific about what you want. Lovable works best with clear, detailed prompts
- Always include the full API details (endpoint, headers, docs link) so Lovable can implement the integration correctly
- Explicitly mention storing the API key in Lovable Cloud for security
- Check out Lovable's [prompt engineering guide](https://docs.lovable.dev/prompting/prompting-one) for more tips on crafting effective prompts
- Be specific about what you want. Lovable works best with clear, detailed prompts.
- Always include the full API details (the endpoint, headers, and docs link) so Lovable can implement the integration correctly.
- Explicitly mention storing the API key in Lovable Cloud for security.
- Check out Lovable's [prompting best practices](https://docs.lovable.dev/prompting/prompting-one) for more tips on crafting effective prompts.
94 changes: 90 additions & 4 deletions docs/vapi.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: VAPI
title: Vapi
---
import { IntegrationHeader } from '/snippets/integration-header.mdx'

Expand All @@ -8,8 +8,94 @@ import { IntegrationHeader } from '/snippets/integration-header.mdx'
partnerAlt="VAPI logo"
/>

[VAPI](https://vapi.ai/) is a voice AI platform for developers, empowering you to build, test, and deploy voice agents in minutes—not months.
![Vapi demo](/images/vapi-demo.gif)

Rime's text-to-speech synthesis (TTS) model is available via the VAPI API. With VAPI's Rime integration, you can build AI voice applications that that sound as natural as a human conversation.
[Vapi](https://vapi.ai) is an API-first platform for building, testing, and deploying AI voice agents. It handles telephony, orchestration, and integrations so you can focus on your agent's behavior. Paired with Rime's ultra-realistic voices, you get natural-sounding conversations with sub-200ms latency. This guide walks you through creating a basic voice assistant with Vapi and Rime.

## Prerequisites

More information is available in [VAPI's documentation](https://docs.vapi.ai/providers/voice/rimeai).
To follow this guide, you need:

- A [Vapi](https://dashboard.vapi.ai) account
- A Rime [API key](https://app.rime.ai/tokens) (optional)

## Step 1: Create the assistant

From the [Vapi Dashboard](https://dashboard.vapi.ai), navigate to **Assistants** and click **Create Assistant**.

![Vapi assistants page with Create Assistant button](/images/vapi-create-assistant-button.png)

### 1.1 Select a template

Give your assistant a name, select **Blank Template**, and click **Create Assistant**.

![Create assistant modal](/images/vapi-create-assistant.png)

### 1.2 Configure the model

In the **Model** tab, select your preferred LLM provider. Any option should work, but models with lower latency enable better conversational flow.

Add a **First Message** to enable your assistant to begin conversations.

Configure a **System Prompt** to define your agent's personality and behavior. The system prompt can be as complex or simple as you like. For example:

```
You are a helpful voice assistant.
Keep your responses short and conversational. No more than 2-3 sentences.
Be friendly and natural.
```

Alternatively, use the **Generate** button and get AI help to create a well-structured prompt.

![Model tab configuration](/images/vapi-model.png)

### 1.3 Configure the voice

In the **Voice** tab, configure your assistant to use **Rime AI** as the **Provider**.

Select the **Voice** that you want your assistant to use. Learn more about Rime's voices on the [Voices](./voices) page.

Set the **Model** to **Arcana** to use the latest Rime model with the most realistic voices.

![Voice tab with Rime AI provider selected](/images/vapi-voice.png)

### 1.4 Configure the transcriber

Finally, in the **Transcriber** tab, select your preferred speech-to-text (STT) **Provider** and click **Publish**.

![Transcriber tab configuration](/images/vapi-transcriber.png)

### 1.5 Publish the assistant

In the publishing popup window, select **Skip and Publish**.

![Publish popup window](/images/vapi-publish-popup.png)

## Step 2: Add your API keys to Vapi (optional)

Vapi provides API access to all its supported models via its billing plans. However, if you already have a subscription plan for one or more of your assistant's configured providers, you can enable the assistant to access them instead of using integrated Vapi billing:

Under the **Build** heading, click **More** and select **Integrations**. Then, find your providers and add your API keys.

![Integrations](/images/vapi-integrations.png)

Vapi stores API keys securely and automatically grants your assistants access to them.

![Rime API key integration](/images/vapi-rime-api-key.png)

## Step 3: Test your assistant

The above steps create the most basic assistant using Rime's voices.

Click **Talk to Assistant** in the dashboard to start a conversation in your browser.

![Vapi demo](/images/vapi-demo.gif)

## Next steps

To further customize your assistant, you can:

- **Try different voices:** Audition other voices like `celeste`, `orion`, and `andromeda` at [app.rime.ai](https://app.rime.ai).
- **Add a phone number:** Provision a contact number in the Vapi dashboard and assign it to your assistant for telephony
- **Create a workflow:** Program your assistant to do complex tasks using [Vapi Workflows](https://dashboard.vapi.ai/workflows).
- **Customize the personality:** Update the system prompt to match your use case.
Binary file added images/lovable-demo.mp4
Binary file not shown.
Binary file added images/vapi-create-assistant-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-create-assistant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-integrations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-publish-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-rime-api-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-transcriber.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/vapi-voice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.