Android Agent Starter

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

This template is free for you to use or modify as you see fit.

Getting started

The easiest way to get this app running is with a token server and the LiveKit CLI.

First, enable the token server from your project's Options on the Settings page in LiveKit Cloud and copy the sandboxID.

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

lk app create --template agent-starter-android --sandbox <token_server_sandbox_id>

Build and run the app in Android Studio.

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

Note

To setup without the LiveKit CLI, clone the repository and edit the TokenExt.kt file to add either a sandboxID (from your project's Options on the Settings page), or a 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 which is integrated with your authentication solution. You should disable the token server and modify TokenExt.kt 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!