Installation & Quickstart

Want the full chat without building a UI? Load the chat in a WebView. It’s the simplest way to add your agent to an app, with the same chat, actions, forms, tickets and voice as your website. See Mobile apps. Use the SDK when you want your own native chat UI.

Prerequisites

Requirement	Minimum
Android API	24 (Android 7.0)
Java	11+
Kotlin Coroutines	Required
Jetpack Compose	Not required — the SDK works with any UI framework

Installation

Kotlin DSL
Groovy

// build.gradle.kts (app module)
dependencies {
    implementation("com.chatbase:chatbase-sdk:0.0.1-alpha03")
}

// build.gradle (app module)
dependencies {
    implementation 'com.chatbase:chatbase-sdk:0.0.1-alpha03'
}

The SDK declares the INTERNET permission in its own manifest. It is merged automatically — you do not need to add it to your app’s manifest.

Quick Start

Get your Agent ID

Go to the Chatbase Dashboard
Select your AI agent
Go to Settings → General
Copy the Agent ID

Enable the Android SDK channel

In the dashboard, go to Deploy → Android SDK and enable the channel for your AI agent.

If the Android SDK channel is not enabled, every SDK request fails with a 404 AGENT_NOT_FOUND error — even when the agent ID is correct.

Create a client

import com.chatbase.sdk.Chatbase

val client = Chatbase.create(context, "YOUR_AGENT_ID")

context can be any Android Context (Activity, Application, etc.). It is only used during creation to generate the device ID.

Send your first message

import com.chatbase.sdk.model.Part

lifecycleScope.launch {
    val response = client.sendMessage("Hello! How can you help me?") {
        onTextDelta { delta ->
            // Called for each text chunk — safe to update UI
            print(delta)
        }
    }

    // Access the full response
    val text = response.parts
        .filterIsInstance<Part.Text>()
        .joinToString("") { it.text }

    println(text)
    println("Conversation: ${response.metadata.conversationId}")
}

Clean up

// In your ViewModel
override fun onCleared() {
    client.close()
}

SDKs

Android SDK

iOS SDK

Installation & Quickstart

Prerequisites

Installation

Quick Start

Next Steps

Streaming

Client-Side Tools

Conversations

Chatbase

​Prerequisites

​Installation

​Quick Start

​Next Steps

Streaming

Client-Side Tools

Conversations

Chatbase

Prerequisites

Installation

Quick Start

Next Steps