Android SDK - FlowX.AI

Android SDK migration guide

FlowX.AI 6.0 moves the Android SDK to compileSdk 37, Android Gradle plugin 9 and Kotlin 2.4, and aligns the SDK’s names with the iOS and web SDKs. Update your build setup first, then the renamed SDK APIs.

System requirements

System requirements:

minSdk = 26 (unchanged)
compileSdk = 37

The SDK library was built using:

Android Gradle Plugin 9.5.0
Gradle 9.8.2
Kotlin 2.4.21

Your container app must build with at least:

Android Gradle Plugin 9.1.0
Gradle 9.3.1 (the minimum depends on your Android Gradle Plugin version)
Kotlin 2.4
JDK 17

Library dependencies

Dependency	5.9.x	6.0
Android Core KTX	1.16.0	1.19.1
Android Activity Compose	1.10.1	1.13.0
Compose BOM	2025.09.01	2026.09.00
Compose Navigation	2.9.1	2.10.2
Android Lifecycle	2.9.1	2.11.0
Kotlin Coroutines	1.10.2	1.11.0
Android DataStore	1.1.7	1.3.0
Android Security	1.1.0-beta01	1.1.0
OkHttp BOM	4.12.0	5.5.1
Retrofit	2.12.0	3.0.0
Coil BOM	3.4.0	3.6.3
Google Protobuf	4.31.1	4.36.2
Mozilla Rhino	1.8.0	1.9.2
Accompanist Permissions	0.37.3	0.37.3
Moshi	1.15.2	1.15.2
Android Core Library Desugaring	2.1.5	2.1.5

The SDK now depends on OkHttp 5 and Retrofit 3. Gradle resolves your app to these versions even if you declare OkHttp 4 or Retrofit 2, so update any code in your app that uses APIs removed in these major versions.

Align your app’s versions of these libraries with the SDK’s versions to avoid compatibility issues.

Migration steps

To build and run your container app with the 6.0 SDK, follow these steps in order:

Update the SDK version

[rootProject]/app/build.gradle.kts

implementation("ai.flowx.android:sdk:<5.9.x version>") 
implementation("ai.flowx.android:sdk:<6.0 version>") 

Find the SDK version that matches your platform version in Release Notes → v6.0 → Deployment guidelines → Component versions.

Increase the compileSdk version to 37

[rootProject]/app/build.gradle.kts

android {
    compileSdk = 35
    compileSdk = 37
}

The SDK and its AndroidX, OkHttp and Coil dependencies require compileSdk 37. Raising targetSdk is not required.

Update the Android Gradle plugin version to at least 9.1.0

[rootProject]/build.gradle.kts

plugins {
    id("com.android.application") version "8.10.0" apply false
    id("com.android.application") version "9.5.0" apply false
}

Android Gradle plugin 9 is a major release with breaking build changes. Consult the Android Gradle plugin 9.0 release notes.

Update the Gradle version

[rootProject]/gradle/wrapper/gradle-wrapper.properties

distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip 
distributionUrl=https\://services.gradle.org/distributions/gradle-9.8.2-bin.zip 

Android Gradle plugin 9.1 requires at least Gradle 9.3.1, and 9.5 requires at least Gradle 9.6.0. Check the minimum for your version in the Android Gradle plugin release notes.

Remove the Kotlin Android plugin

Android Gradle plugin 9 compiles Kotlin by itself (built-in Kotlin), so the org.jetbrains.kotlin.android plugin must be removed:

[rootProject]/build.gradle.kts

plugins {
    id("org.jetbrains.kotlin.android") version "2.2.0" apply false
}

[rootProject]/app/build.gradle.kts

plugins {
    id("org.jetbrains.kotlin.android") 
}

Consult the Migrate to built-in Kotlin guide.

Update the Kotlin version to at least 2.4

With built-in Kotlin, your app compiles with the version of the Kotlin Gradle plugins you declare, such as the Compose Compiler plugin. The Kotlin version that Android Gradle plugin uses by default is too old to read the SDK’s classes.

[rootProject]/build.gradle.kts

plugins {
    id("org.jetbrains.kotlin.plugin.compose") version "2.2.0" apply false
    id("org.jetbrains.kotlin.plugin.compose") version "2.4.21" apply false
}

With an older Kotlin version, the build fails with an error like: The binary version of its metadata is 2.4.0, expected version is 2.2.0.

Use the same version for every Kotlin Gradle plugin your project declares (for example, Parcelize or Serialization).

Make sure core library desugaring is enabled

The SDK requires core library desugaring. If your app does not enable it yet, add:

[rootProject]/app/build.gradle.kts

android {
    compileOptions {
        isCoreLibraryDesugaringEnabled = true
    }
}
dependencies {
    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.5") 
}

Rename the imageBaseUrl and customHeaders properties of the Config interface

imageBaseUrl is now assetsBaseUrl, and customHeaders is now additionalHttpHeaders:

[rootProject]/app/src/main/[java|kotlin]/com/example/MyApp.kt

Flowx.getInstance().init(
    context = applicationContext,
    config = object : Config {
        ...
        override val imageBaseUrl = "URL to FlowX CMS Media Library"
        override val assetsBaseUrl = "URL to FlowX CMS Media Library"
        override val customHeaders: Map<String, String>? = mapOf("Custom-Header" to "custom header value") 
        override val additionalHttpHeaders: Map<String, String>? = mapOf("Custom-Header" to "custom header value") 
        ...
    },
    ...
)

The default value of the locale property changed from Locale.getDefault() to Locale.forLanguageTag("en-US"). If your app relies on the device locale for date, number and currency formatting, set it explicitly:

override val locale: Locale = Locale.getDefault()

Stop passing null to the setAccessToken method

The setAccessToken method no longer accepts null:

fun setAccessToken(accessToken: String?) 
fun setAccessToken(accessToken: String) 

Remove the calls that clear the token (for example, on logout or after a failed login):

Flowx.getInstance().setAccessToken(null)

Passing an empty string ("") no longer clears the token. The SDK sends it as is and the backend rejects the requests.

A token can’t be cleared once set. When another user logs in, set that user’s token. If no token is ever set, the SDK runs in anonymous mode. For details, see the Authentication section of the Android SDK reference.

Rename the closeModalFunc parameter to onDismissRequested

The parameter of the startProcess and continueProcess methods was renamed. Its lambda now runs in the ProjectScope context:

Flowx.getInstance().startProcess(
    ...
    closeModalFunc = { processName -> ... }, 
    onDismissRequested = { processName -> ... }, 
)

Flowx.getInstance().continueProcess(
    ...
    closeModalFunc = { processName -> ... }, 
    onDismissRequested = { processName -> ... }, 
)

Replace the deprecated CloseModalProcessScope type with ProjectScope, as described in the Replace deprecated APIs section.

Rename the imageBaseUrl parameter of the changeEnvironment method (if used)

fun changeEnvironment(baseUrl: String, imageBaseUrl: String, enginePath: String) 
fun changeEnvironment(baseUrl: String, assetsBaseUrl: String, enginePath: String) 

Replace deprecated APIs

The following 5.9 names still compile in 6.0, but they are deprecated and will be removed in the next LTS release. Replace them now:

Deprecated (5.9)	Replacement (6.0)	Available on
`CloseModalProcessScope`	`ProjectScope`	The `onDismissRequested` lambda of `startProcess` and `continueProcess`
`replaceSubstitutionTag(key)`	`getSubstitutionTagContent(key)`	`ProjectScope`, `CustomComponentScope`, `CustomLoaderScope`
`getMediaResourceUrl(key)`	`getMediaItemUrl(key)`	`ProjectScope`, `CustomComponentScope`, `CustomLoaderScope`
`getEnumeration(name, parentName)`	`getEnumerationItems(name, parentName)`	`ProjectScope`, `CustomComponentScope`, `CustomLoaderScope`
`executeAction(action, params)`	`runAction(action, params)`	`CustomComponentScope`
`executeUploadAction(action, fileUri, mimeType, params)`	`runUploadAction(action, fileUri, mimeType, params)`	`CustomComponentScope`
`configureUpdateState(enabled)`	`setUpdateStateEnabled(enabled)`	`Flowx`

Android Studio offers a Replace with quick fix on every deprecated call.

These changes are reflected in an actual implementation as shown below:

import ai.flowx.android.sdk.api.CloseModalProcessScope 
import ai.flowx.android.sdk.api.ProjectScope 

// close process confirmation alert
@Composable
private fun CloseModalProcessScope.CloseModalProcessConfirmAlert(show: MutableState<Boolean>) { 
private fun ProjectScope.CloseModalProcessConfirmAlert(show: MutableState<Boolean>) { 
    ...
    Text(replaceSubstitutionTag("@@close_message")) 
    Text(getSubstitutionTagContent("@@close_message")) 
}

// custom component
flowxScope.executeAction(action = it, params = JSONObject()) 
flowxScope.runAction(action = it, params = JSONObject()) 

// custom loader
flowxScope.replaceSubstitutionTag(text) 
flowxScope.getSubstitutionTagContent(text) 
flowxScope.getMediaResourceUrl(key) 
flowxScope.getMediaItemUrl(key) 

Android SDK reference

Android renderer SDK documentation

Migration overview

Full 5.9.x → 6.0.0 container app upgrade guide

​Android SDK migration guide

​System requirements

​Library dependencies

​Migration steps

​Replace deprecated APIs

​Related resources

Android SDK reference

Migration overview

Android SDK migration guide

System requirements

Library dependencies

Migration steps

Replace deprecated APIs

Related resources