Getting Started

Overview

The Savants Real-Time Voice API provides a simple and secure way to add real-time, two-way voice conversations to your Flutter Windows desktop application.

Prerequisites

Before you begin, ensure you have:

Flutter development environment set up
Windows desktop application (target platform)
Valid API credentials from The Savants
Basic understanding of WebSocket connections

Install Dependencies

Add these packages to your pubspec.yaml:

pubspec.yaml

dependencies:
  http: ^1.2.1
  web_socket_channel: ^2.4.0
  flutter_sound: ^9.2.13 # For low-latency PCM playback
  permission_handler: ^11.0.1 # For microphone permissions
  flutter_dotenv: ^5.1.0 # For environment variables

Environment Setup

Security First: Never hardcode API credentials in your code. Always use environment variables.

1. Create Environment File

Create a .env file in your project root:

.env

API_BASE_URL=https://api.thesavants.ai
DEVICE_API_KEY=YOUR_DEVICE_API_KEY
DEVICE_ID=YOUR_DEVICE_UUID

2. Configure Assets

Add to your pubspec.yaml:

pubspec.yaml

flutter:
  assets:
    - .env

3. Load Environment Variables

main.dart

import 'package:flutter_dotenv/flutter_dotenv.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await dotenv.load(fileName: ".env");
  runApp(MyApp());
}

Security Best Practices

Environment Variables

Use .env files and never commit credentials to version control

API Key Protection

Store DEVICE_API_KEY securely - treat it as a secret credential

Local Storage

Use encrypted local storage for desktop applications when needed

Git Ignore

Always add .env to your .gitignore file

Next Steps

Once your environment is configured:

Implementation

​Overview

​Prerequisites

​Install Dependencies

​Environment Setup

​1. Create Environment File

​2. Configure Assets

​3. Load Environment Variables

​Security Best Practices

Environment Variables

API Key Protection

Local Storage

Git Ignore

​Next Steps

Overview

Prerequisites

Install Dependencies

Environment Setup

1. Create Environment File

2. Configure Assets

3. Load Environment Variables

Security Best Practices

Next Steps