> ## Documentation Index
> Fetch the complete documentation index at: https://rimelabs-docs-coda-websocket-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Vapi

> Connect Rime TTS to Vapi for phone-based voice agents and IVR systems.

export const IntegrationHeader = ({partnerLogo, partnerAlt = "Partner logo", rimeLogo = "/images/rime_logo_new.svg", rimeAlt = "Rime logo", rimeHeight = "40px", partnerHeight = "40px"}) => <div style={{
  width: "100%",
  display: "flex",
  flexDirection: "row",
  alignItems: "center",
  justifyContent: "center",
  gap: "12px",
  flexWrap: "nowrap",
  marginBottom: "24px"
}}>
    <img src={rimeLogo} style={{
  height: rimeHeight,
  display: "inline-block"
}} alt={rimeAlt} />
    <span style={{
  fontSize: "24px",
  color: "#666",
  display: "inline-block"
}}>
      +
    </span>
    <img src={partnerLogo} style={{
  height: partnerHeight,
  display: "inline-block"
}} alt={partnerAlt} />
  </div>;

<IntegrationHeader partnerLogo="/images/vapi.png" partnerAlt="VAPI logo" />

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-demo.gif?s=ffbd3b5d90e8882980817580677440be" alt="Vapi demo" width="956" height="950" data-path="images/vapi-demo.gif" />

Configure a [Vapi](https://vapi.ai) assistant to use Rime for speech. Vapi handles telephony and orchestration; this guide covers the model, voice, transcriber, publishing, and optional bring-your-own-key settings.

## Prerequisites

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

In the [Vapi Dashboard](https://dashboard.vapi.ai), open **Assistants** and select **Create Assistant**.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-create-assistant-button.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=2d9270675b14cfba4ea7b88b412e6ab4" alt="Vapi assistants page with Create Assistant button" width="3840" height="1934" data-path="images/vapi-create-assistant-button.png" />

### 1.1 Select a template

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

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-create-assistant.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=21592b8bb83234d47a5978c73bdbebc9" alt="Create assistant modal" width="3840" height="1932" data-path="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. 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, select **Generate** to draft the prompt.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-model.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=c4a99cffde2ff7ed480e2b51e670b126" alt="Model tab configuration" width="3840" height="1936" data-path="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. See the [Voices](/docs/voices) page for the Rime catalog.

Set the **Model** to **Coda**, Rime's current model.

If your Vapi account does not offer Coda in the **Model** list, contact [support@rime.ai](mailto:support@rime.ai) before publishing the assistant.

### 1.4 Configure the transcriber

In the **Transcriber** tab, select your preferred speech-to-text (STT) **Provider**, then select **Publish**.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-transcriber.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=f43c655fd951e4b25ed905b59afe5f10" alt="Transcriber tab configuration" width="3840" height="1934" data-path="images/vapi-transcriber.png" />

### 1.5 Publish the assistant

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

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-publish-popup.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=de2c92d040db586437cd1e3531a4d897" alt="Publish popup window" width="3840" height="1938" data-path="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:

In the **Build** section, open **More → Integrations**. Find each provider and add its API key.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-integrations.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=befe50b6f3ca4c8b54dc33e773f0a3be" alt="Integrations" width="3840" height="1934" data-path="images/vapi-integrations.png" />

Vapi stores provider keys under **Integrations** and makes them available to your assistants.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-rime-api-key.png?fit=max&auto=format&n=xMxMMVm2kXbTWDmY&q=85&s=20e1352621066fa41e3a940d395cffd8" alt="Rime API key integration" width="3840" height="1938" data-path="images/vapi-rime-api-key.png" />

## Step 3: Test your assistant

In the Vapi Dashboard, select **Talk to Assistant** to start a conversation in your browser.

<img src="https://mintcdn.com/rimelabs-docs-coda-websocket-reference/xMxMMVm2kXbTWDmY/images/vapi-demo.gif?s=ffbd3b5d90e8882980817580677440be" alt="Vapi demo" width="956" height="950" data-path="images/vapi-demo.gif" />

## Extend the assistant

* **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.