Getting Started Guide

Everything you need to integrate Tkalam Localize into your application in 10 minutes

10 minute setup
No credit card required
Free tier available

Choose Your Path

Pick the approach that works best for your learning style

RECOMMENDED

No-Code Start

Try APIs in the playground first, no coding required

5 minutes

Code-First

Jump straight to API integration with code examples

10 minutes

Deep Dive

Comprehensive guide covering all features and best practices

30 minutes
1

Create Your Account

2 minutes

Sign up for a free Tkalam Localize account to get started. No credit card required.

What you get with the free tier:

  • • 10,000 translation characters per month
  • • 60 seconds of Text-to-Speech
  • • 30 seconds of Speech-to-Text
  • • Full access to all dialects and styles
  • • API playground and documentation
Create Free AccountAlready have an account?Sign in
2

Generate Your API Key

1 minute

After signing in, navigate to your dashboard and create your first API key.

1

Go to API Keys page

Find it in the left sidebar of your dashboard

2

Click "Create New Key"

Give it a descriptive name like "Production App" or "Testing"

3

Copy and save your key

Store it securely - you won't be able to see it again

Security Best Practices:

  • • Never commit API keys to version control
  • • Use environment variables to store keys
  • • Create separate keys for development and production
  • • Rotate keys regularly and delete unused ones
Create API Key
3

Make Your First API Call

3 minutes

Now let's translate your first text. Choose your preferred language below:

JavaScript / Node.js
const response = await fetch('https://api.tkalam.com/v1/translate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    text: "Hello, how are you?",
    target_dialect: "darija",
    style: "informal"
  })
});

const data = await response.json();
console.log(data.output_text); // السلام، كيداير؟
Python
import requests

response = requests.post(
    'https://api.tkalam.com/v1/translate',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'text': 'Hello, how are you?',
        'target_dialect': 'darija',
        'style': 'informal'
    }
)

data = response.json()
print(data['output_text'])  # السلام، كيداير؟
cURL
curl -X POST https://api.tkalam.com/v1/translate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello, how are you?",
    "target_dialect": "darija",
    "style": "informal"
  }'

Understanding the Response:

{
  "detected_source_lang": "en",
  "target_dialect": "darija",
  "task": "translate",
  "style": "informal",
  "output_text": "السلام، كيداير؟",
  "latin_transliteration": "salam, kidayer?"
}
4

Try the Playground

2 minutes

Before integrating into your app, experiment with different dialects and styles in our interactive playground.

🌍

Translation

Test all three dialects with 6 style variations

🔊

Text-to-Speech

Listen to natural voices in different dialects

🎤

Speech-to-Text

Upload audio and see transcription results

Open Playground
5

Monitor Usage & Deploy

2 minutes

Track your API usage, monitor performance, and scale as you grow.

Analytics Dashboard

View real-time usage metrics, track API calls, and monitor quota consumption.

Production Ready

Our infrastructure is built for scale with 99.9% uptime and global CDN delivery.

Ready for production?

Review our best practices guide and consider upgrading to a paid plan for higher quotas and priority support.

You're All Set!

You now have everything you need to build amazing Maghreb-native applications