EndpointsText Processing

Transliteration

View as Markdown
**Transliteration** converts text from one script to another while preserving the original pronunciation. For example, **'नमस्ते'** becomes **'namaste'** in English, and **'how are you'** can be written as **'हाउ आर यू'** in Devanagari. This process ensures that the sound of the original text remains intact, even when written in a different script. Transliteration is useful when you want to represent words phonetically across different writing systems, such as converting **'मैं ऑफिस जा रहा हूँ'** to **'main office ja raha hun'** in English letters. **Translation**, on the other hand, converts text from one language to another while preserving the meaning rather than pronunciation. For example, **'मैं ऑफिस जा रहा हूँ'** translates to **'I am going to the office'** in English, changing both the script and the language while conveying the intended message. ### Examples of **Transliteration**: - **'Good morning'** becomes **'गुड मॉर्निंग'** in Hindi, where the pronunciation is preserved but the meaning is not translated. - **'सुप्रभात'** becomes **'suprabhat'** in English. Available languages: - **`en-IN`**: English - **`hi-IN`**: Hindi - **`bn-IN`**: Bengali - **`gu-IN`**: Gujarati - **`kn-IN`**: Kannada - **`ml-IN`**: Malayalam - **`mr-IN`**: Marathi - **`od-IN`**: Odia - **`pa-IN`**: Punjabi - **`ta-IN`**: Tamil - **`te-IN`**: Telugu For hands-on practice, you can explore the notebook tutorial on [Transliterate API Tutorial](https://github.com/sarvamai/sarvam-ai-cookbook/blob/main/notebooks/transliterate/Transliterate_API_Tutorial.ipynb).

Authentication

api-subscription-keystring
API Key authentication via header

Request

This endpoint expects an object.
inputstringRequired<=1000 characters
The text you want to transliterate.
source_language_codeenumRequired

The language code of the input text. This specifies the source language for transliteration.

Note: The source language should either be an Indic language or English. As we supports both Indic-to-English and English-to-Indic transliteration.

target_language_codeenumRequired

The language code of the transliteration text. This specifies the target language for transliteration.

Note:The target language should either be an Indic language or English. As we supports both Indic-to-English and English-to-Indic transliteration.

numerals_formatenumOptional

numerals_format is an optional parameter with two options:

  • international (default): Uses regular numerals (0-9).
  • native: Uses language-specific native numerals.

Example:

  • If international format is selected, we use regular numerals (0-9). For example: मेरा phone number है: 9840950950.
  • If native format is selected, we use language-specific native numerals, like: मेरा phone number है: ९८४०९५०९५०.
spoken_form_numerals_languageenumOptional

spoken_form_numerals_language is an optional parameter with two options and only works when spoken_form is true:

  • english : Numbers in the text will be spoken in English.
  • native(default): Numbers in the text will be spoken in the native language.

Examples:

  • Input: “मेरे पास ₹200 है”
    • If english format is selected: “मेरे पास टू हन्डर्ड रूपीस है”
    • If native format is selected: “मेरे पास दो सौ रुपये है”
spoken_formbooleanOptionalDefaults to false
  • Default: False
    • Converts text into a natural spoken form when True.
    • Note: No effect if output language is en-IN.

Example:

  • Input: मुझे कल 9:30am को appointment है
    • Output: मुझे कल सुबह साढ़े नौ बजे को अपॉइंटमेंट है

Response

Successful Response
request_idstring or null
transliterated_textstring
Transliterated text result in the requested target language.
source_language_codestring
Detected or provided source language of the input text.

Errors

400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error