API & SDK overview
Kalima exposes two client-facing technical surfaces and one optional automation layer.
1. JavaScript SDK
Use the JavaScript SDK when you want Kalima to operate close to the browser runtime.
What it handles well:
- Fetching approved translations for the active locale
- Requesting instant translation for approved misses when enabled
- Applying translated strings to DOM content
- Showing a language switcher
- Managing URL-based locale selection
- Applying CSS masking until translations are ready
Start with JavaScript SDK.
2. Public SDK API
Use the public SDK API when your application needs tighter control over rendering, caching, or phrase collection.
What it handles well:
- Returning public project settings by project key
- Returning approved translations for a locale
- Accepting batched phrase extraction payloads
- Accepting instant translation requests for eligible projects
- Returning ordered per-item translation source metadata
Start with API reference.
3. Advanced automation
Kalima also exposes GitHub Actions for teams that want repository-based locale sync and phrase discovery. This is optional, not required for a standard client integration.
Automation guides:
Which one should you choose?
| Need | Recommended surface |
|---|---|
| Fastest browser-based setup | JavaScript SDK |
| Custom rendering and app-managed state | Public SDK API |
| Repo-driven locale sync in CI | Advanced automation |
Support
Need help shipping this integration?
If you hit a blocker, contact Kalima with your project key, target environment, and a short description of what failed.