U
UpVoot Docs

Quick Start

Make your first AI voice call in under 5 minutes.

Prerequisites

  • An UpVoot account (sign up free — 10 minutes included)
  • A WebSocket-capable telephony provider (Exotel, Twilio, Airtel IQ, or any SIP gateway)

Step 1 — Create an agent

Go to Dashboard → Agents and click New agent. Fill in:

  • Name — Internal label, not heard by callers.
  • System prompt — Instructions that define the agent's role, tone, and constraints. Example:
    You are a friendly appointment reminder agent for Dr. Sharma's clinic.
    Confirm the patient's appointment for tomorrow at 10 AM.
    Speak in Hinglish. Be brief — under 3 turns.
  • Greeting — The first sentence the agent speaks when the call connects. Example: "Namaste! Main Dr. Sharma ke clinic se bol raha hoon."

Click Save.

Step 2 — Generate an API key

Go to Dashboard → API Keys and click New key. Select the agent you just created.

The raw key is shown exactly once — copy it immediately. It looks like:

sk_live_a3f9c2d1e84b7f5a6c2d9e1f3b8a4d7c2e9f1a3b5c8d2e4f6a8b1c3d5e7f9a2

The key prefix shown in the UI (e.g. sk_live_…f9a2) is safe to share for identification — it cannot reconstruct the raw key.

Step 3 — Connect your telephony provider

Configure your telephony provider to forward incoming (or outbound) calls to UpVoot via WebSocket. Use this URL format:

wss://api.upvoot.com/voice/<your-api-key>

Replace <your-api-key> with the raw key from Step 2. The connection uses standard WebSocket — no additional headers or SDKs required.

See Supported Providers for provider-specific setup guides (Exotel, Twilio, Airtel IQ).

Step 4 — Test it

In the dashboard, navigate to your agent and click Test call. Enter your raw API key and the worker URL, then click Start call. You'll hear the greeting immediately.

Alternatively, use websocat from the terminal:

# Install websocat
brew install websocat

# Connect (audio streaming not included in this example)
websocat wss://api.upvoot.com/voice/sk_live_YOUR_KEY

Step 5 — Monitor the call

After the call ends, navigate to Usage to see the transcript, duration, and points deducted. Each minute of call time costs 1 point.

Next steps

On this page

No Headings