Transliteration

The Transliteration API is a REST API used to transliterate the content from English to Indic languages and vice-versa.

Getting Started

In this guide, you’ll learn how to automatically transcribe live streaming audio in real time using Reverie’s SDKs, which are supported for use with the Reverie API.

Before you start, you’ll need to follow the steps in the Get your API Credentials to obtain your API KEY & APP ID.

Make your first Call

Make your first API Call using the cURL request. Add your own API Credentials where it says <YOUR-APP-ID> & <YOUR-API-KEY> and then run the following example in a terminal or your favorite API client.

curl --location --request POST 'https://revapi.reverieinc.com/' \
--header 'Content-Type: application/json' \
--header 'REV-API-KEY: <YOUR API-KEY>' \
--header 'REV-APP-ID: <YOUR APP-ID>' \
--header 'src_lang: en' \
--header 'tgt_lang: hi' \
--header 'domain: generic' \
--header 'cnt_lang: en' \
--header 'REV-APPNAME: transliteration' \
--header 'REV-APPVERSION: 2.0' \
--data-raw '{"data": ["Reverie Language Technologies ltd website address is www.reverieinc.com"],
}'

By default, The API will return the strings in the target language.

SDKs

Reverie has several SDKs that can make it easier to use the API. Follow these steps to use the SDK of your choice to make a Reverie Transliteration request.

Install Dependencies

JavaScript

npm i @reverieit/reverie-client

Transliterate Text to your preferred language

The following code shows how to convert the text to your preferred language.

JavaScript

const ReverieClient = require("reverie-client");

const reverieClient = new ReverieClient({
  apiKey: "YOUR-API-KEY",
  appId: "YOUR-APP-ID",
});

async function transliterateText() {
  const translation = await reverieClient.transliterate({
    text: "Namaste",
    src_lang: "en",
    tgt_lang: "ta",
  });
  console.log(translation);
}

transliterateText();

Results

In order to see the results from Reverie, you must run the application. Run your application from the terminal. Your transcripts will appear in your shell.

JavaScript

# Run your application using the file you created in the previous step
# Example:
npm start

Analyzing the Response

The API returns a responseList, which is an array containing the transliterated content. Each item includes the inString, representing the original text in the source script, and the corresponding outString, which is the result of converting that text into the target script. Additionally, the response includes an api_status field, where a value of 2 indicates a successful transaction.

Key Features

Real-Time Transliteration

Converts English to 22 Indic languages and vice-versa instantly, ensuring seamless integration.

Context-Aware Transliteration

Identifies word context for accurate transliteration, reducing editorial work.

Custom Vocabulary

Tailors transliterations for specific use-cases like product names or terminology.

Multi-Domain Support

Supports domains like healthcare, ecommerce, and more for precise transliteration.

Wide Language Coverage

Supports 22 Indic languages, including rare ones, for forward and reverse transliteration.

Flexible Deployment

Offers cloud-based and on-premise solutions for diverse platform integration.

Supported Languages

Language	Language Code
Hindi	hi
Assamese	as
Bengali	bn
Gujarati	gu
Kannada	kn
Malayalam	ml
Marathi	mr
Odia	or
Punjabi	pa
Tamil	ta
Telugu	te
English	en
Urdu	ur
Sindhi	sd
Dogri	doi
Konkani	kon
Bodo	brx
Kashmiri	ks
Maithili	mai
Manipuri	mni
Sanskrit	sa
Santhali	sat

Supported Domains

Domain ID	Description
generic	Transliterates generic content regardless of specific domain.
pii_names	Transliterates people’s names and surnames.
pii_addresses	Transliterates location details like street name, city name, state, etc.
OnlyEnglish	Transliterates source content from English script to Indic language script.
bfsi	Transliterates banking and financial terminologies accurately.
ecommerce	Transliterates brand and product catalog in the ecommerce domain.
food	Transliterates food and grocery items like menus, packaged food, and more.
infotainment	Transliterates song lyrics, movie titles, artist names, and media content.
medical	Transliterates healthcare terms like medicine names and insurance (Hindi only).
enterprise	Transliterates job titles, company names, and corporate terminology.

Sample Code

Python

Access Python SDK samples for seamless content transliteration using Reverie’s Transliteration API. Ideal for server-side script conversion.

JavaScript

Explore JavaScript SDK examples to integrate real-time transliteration into web applications and browser-based experiences.

GoLang

Find GoLang SDK samples for fast, scalable transliteration solutions in backend systems and APIs.

FAQs

What languages are supported by the Transliteration API?

The Transliteration API supports 22 Indic languages, including Hindi, Tamil, Bengali, and rare languages like Santhali, for forward and reverse transliteration.

Can I customize transliterations for specific domains?

Yes, the API supports domain-specific transliteration (e.g., ecommerce, medical, banking) for accurate script conversion based on context.

Does the API preserve pronunciation?

Absolutely. The API converts scripts while maintaining phonetic similarity, ensuring pronunciation and meaning remain intact.

Can I create a custom vocabulary for my brand?

Yes, Reverie offers customizable vocabulary models to tailor transliterations for brand-specific terms, names, or use-cases.

How fast is the transliteration process?

The Transliteration API provides real-time transliteration, converting content instantly for seamless integration across platforms.

API Messages

Status Code	Status Type	Message	Description
200	Success/OK	-	Successfully executed the request.
400	Bad Request	Message depending on the missing parameter	Incorrect request format or data posted incorrectly.
403	Forbidden	Invalid REV-API-KEY or REV-APP-ID	Entered invalid credentials.
403	Forbidden	usage exhausted	The provided credits or character limit is exhausted.
403	Forbidden	API key expired	The API key provided to a user is expired.
403	Forbidden	unauthorized to use this src/tgt language	Invalid language code passed or user cannot use the defined language code.
403	Forbidden	unauthorized to use this API	The REV-APPNAME entered is invalid, or the user is not authorized to use it.
500	Internal Server Error	Internal Server Error	An error occurred with the API.