Swift Voice Assistant

This is a starter template for LiveKit Agents that provides a simple voice interface using the LiveKit Swift SDK.

This template is comaptible with iOS, iPadOS, macOS, and visionOS and is free for you to use or modify as you see fit.

Getting started

The easiest way to get this app running is with the Sandbox for LiveKit Cloud and the LiveKit CLI.

First, create a new Sandbox Token Server for your LiveKit Cloud project.

Then, run the following command to automatically clone this template and connect it to LiveKit Cloud.

lk app create --template voice-assistant-swift --sandbox <token_server_sandbox_id>

Built and run the app from Xcode by opening VoiceAssistant.xcodeproj. You may need to adjust your app signing settings to run the app on your device.

You'll also need an agent to speak with. Try our sample voice assistant agent for Python, Node.js, or create your own from scratch.

Note

To setup without the LiveKit CLI, clone the repository and then either create a VoiceAssistant/.env.xcconfig with a LIVEKIT_SANDBOX_ID (if using a Sandbox Token Server), or open TokenService.swift and add your manually generated URL and token.

Token generation

In a production environment, you will be responsible for developing a solution to [generate tokens for your users])(https://docs.livekit.io/home/server/generating-tokens/) which is integrated with your authentication solution. You should disable your sandbox token server and modify TokenService.swift to use your own token server.

Contributing

This template is open source and we welcome contributions! Please open a PR or issue through GitHub, and don't forget to join us in the LiveKit Community Slack!