Skip to main content

​
Overview

This quickstart guide will help you set up Unlingo and integrate it into your application in just a few minutes. We’ll create a project, add some translations, and fetch them using our REST API.

​
Prerequisites

  • An Unlingo account (sign up at unlingo.com)
  • Basic knowledge of REST APIs
  • A web or mobile application project

​
Step 1: Create Your Project

1

Sign in to Dashboard

Navigate to unlingo.com and sign in to your account.
2

Create New Project

Click Create Project and enter your project details.
3

Create Namespace

Within your project, create a namespace: - Name: “translation” (you can use any name but i18next uses “translation” by default)

​
Step 2: Add New Language

1

Navigate to your namespace

Navigate to your namespace
2

Select version

Select main version
3

Create language

Click Add language and enter the language code (e.g., en)

​
Step 3: Add Translations

1

Open language editor

Click on the language card
2

Open JSON edit

Click JSON Mode
3

Add translations

Paste your translations in JSON format
{
  "welcome": "Welcome to our application",
  "login": "Sign In",
  "logout": "Sign Out",
  "nav": {
    "home": "Home",
    "about": "About",
    "contact": "Contact"
  }
}
4

Save changes

Click Apply Changes and Click Save Changes in top right corner

​
Step 4: Create Your First Release

1

Navigate to Releases

Go to the Releases tab in your project dashboard
2

Create Release

Click Create Release and enter: - Tag: “1.0.0”. Select your translation namespace and main version
3

Publish

Click Create Release to make it available via the API

​
Step 4: Get Your API Key

1

Navigate to API Keys

Go to the API Keys tab in your project dashboard
2

Create API Key

Click Generate Key and give it a name like Production API Key
3

Copy Key

Copy the generated API key - you’ll need it for the next step
Save your key somewhere safe because it will not be shown again.

​
Step 5: Fetch Translations

Now you can fetch your translations using our API: 
curl -X GET "https://api.unlingo.com/v1/translations?tag=1.0.0&namespace=translation&lang=en" \
  -H "Authorization: Bearer YOUR_API_KEY"
Expected response: 
{
    "translation": {
        "welcome": "Welcome to our application",
        "login": "Sign In",
        "logout": "Sign Out",
        "nav": {
            "home": "Home",
            "about": "About",
            "contact": "Contact"
        }
    }
}

​
Common Patterns

​
Environment-Based Tags

Use different tags for different environments: 
const tag = process.env.NODE_ENV === 'production' ? '1.0.0' : 'staging';

const translations = await fetch(`https://api.unlingo.com/v1/translations?tag=${tag}&namespace=translation&lang=en`, {
    headers: {
        Authorization: `Bearer ${process.env.UNLINGO_API_KEY}`,
    },
});

​
Troubleshooting

Make sure your API key is correct. Check that you’re using the correct project ID.
Verify that:
  • Your release is published
  • The version, namespace, and language parameters are correct
  • Your translations were saved properly in the dashboard
Need help? Join our Discord for community support.

​
Next Steps

Core Concepts

Understand projects

Namespaces

Organize your translations within projects using namespaces

Versions

Understand the relationship between versions and releases

Translations

Deep dive into translation management