Agent Starter App - Android

VideoSDK enables you to add a voice-enabled AI agent to your Android app. This guide walks you through connecting your Android frontend to an agent configured and deployed directly from the VideoSDK dashboard.

Prerequisites

• A deployed AI agent on VideoSDK Agent Cloud. If you haven't done this yet, create and deploy your agent using the Low-Code Deployment UI on the VideoSDK Dashboard. Once deployed, note down your Agent ID.
• Android 8.0 (API level 26) or later
• Android Studio (latest stable) with JDK 17
• Valid Video SDK Account

info

Explore the complete Quickstart implementation in the Android Agent Starter and see how to run and customize it for your own use case.

Generate Token

To manage secured communication, every participant that connects to a meeting needs an access token. You can easily generate this token by using your apiKey and secret-key, which you can obtain from the VideoSDK Dashboard.

For development purpose, you can generate a temporary token from VideoSDK Dashboard's API section.

tip

The best practice for obtaining a token involves generating it from your backend server which will help in keeping your credentials safe.

Run the Sample Project

Step 1: Clone the sample project

1

Clone the sample project

Clone the repository to your local environment.

git clone https://github.com/videosdk-live/agent-starter-app-android.git
cd agent-starter-app-android

Step 2: Open in Android Studio

2

Open in Android Studio

Launch Android Studio and open the agent-starter-app-android folder. Let Gradle finish syncing before proceeding.

Step 3: Create Your Agent (Optional)

3

Create Your Agent (Optional)

info

If you've already configured and deployed your agent from the VideoSDK Dashboard, you can jump directly to Step 4.

You can create and configure a powerful AI agent directly from the VideoSDK dashboard — no coding required.

Step 1: Create Your Agent

1

Create Your Agent

First, follow our detailed guide to Build a Custom Voice AI Agent in Minutes. This will walk you through creating the agent's persona, configuring its pipeline (Realtime or Cascading), and testing it directly from the dashboard.

Step 2: Get Agent and Version ID

2

Get Agent and Version ID

Once your agent is created, you need to get its agentId and versionId to connect it to your frontend application.

1. After creating your agent, go to the agent's page and find the JSON editor on the right side. Copy the agentId.

2. To get the versionId, click on the 3 dots beside the Deploy button and click on "Version History". Copy the version ID via the copy button of the version you want.

Step 4: Setup Environment Variables

4

Setup Environment Variables

Copy the local.properties.example file to local.properties at the project root.

cp local.properties.example local.properties

Update the local.properties file with your credentials. The agentId is the identifier for the Low-Code agent you deployed from the VideoSDK Dashboard.

local.properties

authToken=your_videosdk_auth_token
agentId=your_agent_id
meetingId=your_meeting_id
versionId=your_version_id

tip

You can obtain your authToken and agentId from the VideoSDK Dashboard under your Agent Cloud deployment. meetingId and versionId are optional — if left blank, the app will create a new meeting automatically and use the latest deployed version of your agent.

Step 5: Run the Sample App

5

Run the Sample App

Bingo, it's time to push the launch button.

Connect a physical Android device (or start an emulator running API 26+), select it as the run target in Android Studio, and click the Run button (or press Shift + F10).

You can also install a debug build from the command line:

./gradlew installDebug

Once running, the app will use the Dispatch API to send your deployed agent into the meeting room. You'll see the live transcription as you speak, and the agent will respond in real time.

Troubleshooting

Common Issues:

1. Agent not joining:

   • Check that the agentId and versionId in your local.properties are correctly set.
   • Verify your VideoSDK token is valid and has the necessary permissions.

2. Audio not working:

   • Check device permissions for microphone access.
   • Ensure RECORD_AUDIO permission is declared in AndroidManifest.xml.

3. "Failed to connect agent" error:

   • Verify your agentId and versionId are correct.
   • Check the debug console for any network errors.

4. Android build issues:

   • Ensure you are running Android 8.0 (API level 26) or higher.
   • Verify JDK 17 is configured in Android Studio under File → Project Structure → SDK Location.
   • Confirm Android Gradle Plugin version is 9.0.1 and Kotlin version is 2.0.21.
   • Try cleaning the build: ./gradlew clean.
   • Try File → Invalidate Caches / Restart in Android Studio, then sync Gradle again.