The Mobile SDK is in beta. It is currently installed directly from our GitHub
repository rather than from a package registry. We are preparing releases for Maven
Central, pub.dev and npm, after which installation becomes a one-line
dependency and these guides will be updated. Until then, follow the install steps for
your framework below — they work today and take about fifteen minutes.Beta also means the API may change between updates. See What beta means
before you start.
What the SDK handles for you
Everything in the grey box below is SDK code you no longer write or maintain:
What stays yours: the backend endpoint that calls the Identify API.
The SDK never talks to LearnInk’s API directly and never sees your API key — that
separation is deliberate and unchanged. If you have not built that endpoint yet, start
with Step 1 of the WebView setup guide.
Platform support
The SDK targets Android, across all three frameworks. Minimum versions are below.
Before you start
You need the same three things as the manual integration:- ✅ Your API key — used by your backend, never by the app. Generate one in the LearnInk admin portal (Settings → Developers → API Keys).
- ✅ Your org ID — your organisation’s unique identifier.
- ✅ A backend token endpoint that calls the Identify API and returns a token to your app. See Step 1 of the WebView setup guide.
- ✅ Access to the SDK repository at github.com/LearnInkTeam/learnink-sdk. If you get a 404, email support@learn.ink with the GitHub usernames that need access.
Install guides
Pick your framework. Each guide is self-contained and assumes no prior knowledge of the SDK.Native Android
Kotlin / Java
Flutter
Dart
React Native
JavaScript & TypeScript
Offline behaviour
How cached content works, and what your app must show when nothing is cached.
Troubleshooting
Fixes for the problems beta testers hit most often.
What beta means for you
1
Installation is from GitHub, not a registry
You clone the repository and build the SDK locally once. Every developer on your team
(and your CI) does this. It is a one-off command per machine, documented in each
install guide.
2
Pin to a tag, not to main
main moves. Check out a released tag — for example v0.1.0 — so your builds are
reproducible and your team is on the same code. We will tell you when a new tag is
available and what changed.3
The API may change
We may rename or add things in response to beta feedback. Changes are listed in the
repository’s
CHANGELOG.md, and we will email beta participants before anything
breaking lands.4
Migrating to the registries will be easy
When we publish, the only change is the dependency line — you remove the local build
step and point at the published version. The code you write against the SDK stays the
same.
5
Tell us what hurts
That is the point of the beta. Bugs, confusing APIs, missing callbacks, unclear docs —
email support@learn.ink or open an issue on the repository.