Foundry Local for Android
Run generative AI models directly on Android devices — no cloud, no cost per request, fully private.
Quick Start •
Examples •
Docs
---
> **Preview:** Foundry Local for Android is under active development. APIs, capabilities, and behavior
> may change between preview releases. Review the release notes and validate your app before upgrading.
## Quick Start
```kotlin
suspend fun runChat(context: Context, modelAlias: String) {
val config = Configuration(appName = "my-app")
val manager = FoundryLocalManager.create(context, config)
val model = manager.getCatalog().getModel(modelAlias)
model.download(progress = { progress -> Log.d("DL", "$progress%") })
model.load()
val chat = model.createChatClient()
chat.completeChatStreaming(
ChatCompletionRequest(messages = listOf(ChatMessage.user("Hello!")))
).collect { chunk ->
print(chunk.delta)
}
}
```
That's it — model downloaded, loaded, and generating text on-device.
The application supplies `modelAlias` from its model selection or configuration.
> **Running on Windows or macOS?** See [Foundry Local](https://github.com/microsoft/Foundry-Local).
---
## How It Works
Foundry Local runs AI models on the Android device. Choose one deployment mode:
- **IPC mode** — Your app includes a thin SDK library (no native code). Inference runs in the Foundry Local service app, a separate process. This mode keeps your APK small, provided the [Foundry Local App](https://play.google.com/store/apps/details?id=com.microsoft.foundrylocal.app) has been downloaded. Preferred if you have strict APK size limitations.
- **Embedded mode** — Your app bundles the full inference engine including native libraries. No Foundry Local service app needed. Fully self-contained. Preferred if your app must work without depending on other installed apps
Both modes expose the same Kotlin API. Their installation, packaging, process, storage, and lifecycle
behavior differ.
---
## Setup
Foundry Local distributes each deployment mode as a separate AAR. Add exactly one to your
application.
### IPC Mode
1. Download `foundry-local-ipc-sdk-