Skip to main content

Documentation

Getting Started

Set up LocaleLens and manage your first translations in minutes

Quick Start
1
Create an Account

Sign up for a free account to get started with LocaleLens.

Sign Up Free
2
Create a Project

Once signed in, create your first project from the dashboard. Each project can have multiple locales and thousands of translation keys.

3
Add Locales & Translations

Import existing translations from JSON/CSV (locales are auto-created), or manually add locales and create translation keys using the translation matrix.

4
Get Your API Key

Generate an API key from your project's API Keys tab to fetch translations programmatically in your application.

Understanding Translation Keys

LocaleLens uses dot-notation keys to organize your translations. This structure helps keep your translations organized and enables automatic namespace detection.

Examples:

common.save → namespace: "common"
auth.login.title → namespace: "auth"
errors.validation.email → namespace: "errors"

The namespace is automatically extracted from the first segment of your key (everything before the first dot).

Translation Values

LocaleLens stores translation values as opaque strings. It does not interpret, validate, or enforce any i18n message format.

This means you can use any syntax your framework supports — ICU MessageFormat, simple placeholders, or plain text. LocaleLens treats them all the same.

Recommended Practices

  • Prefer explicit keys over embedded logic
  • Avoid complex grammar logic inside values
  • LocaleLens does not validate placeholders or message syntax
  • AI translations may modify formatting — always review
Import & Export

Quickly import existing translations or export to use in your application.

Import

Supported formats:

  • JSON - Nested or flat structure
  • CSV - Key + locale columns
Export

Export options:

  • JSON - Ready for i18n libraries
  • CSV - For external translators
API Integration

Use the REST API to fetch translations programmatically in your application.

Generate API Key
  1. Go to your project's "API Keys" tab
  2. Click "Create API Key"
  3. Copy and save the key immediately (shown only once)
  4. Use the key in your application
fetch('https://localelens.ai/api/v1/projects/PROJECT_ID/translations/en', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
})
View API Documentation
Next Steps

Ready to integrate LocaleLens with your application?

Framework Guides
→ Next.js Integration→ React Integration
API Reference
→ Full API Documentation