Converts a text from one script to another script (e.g. katakana to latin)
To transliterate a text, send a POST request to Intento API at https://api.inten.to/ai/text/transliterate. Specify the source text, source languages and the desired provider in JSON body of the request as in the following example:
curl -XPOST -H 'apikey: YOUR_API_KEY' 'https://api.inten.to/ai/text/transliterate' -d '{
"context": {
"text": "こんにちは",
"language": "ja",
"fromscript": "jpan",
"toscript": "latn"
},
"service": {
"provider": "ai.text.transliterate.microsoft.translator_text_api.3-0"
}
}'
The response contains the transliterate results grouped by part of speech and a service information. Parts of speech are formatted in snake_case style:
{
"results": [
"Kon'nichiwa"
],
"meta": {
"timing": {
"total": 0.246434,
"providers": 0.201087
},
"client_key_label": "production"
},
"service": {
"provider": {
"id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
"name": "Microsoft Translator API v3.0",
"timing": {
"provider": 0.201087
}
}
}
}
Transliterating multiple segments with single request:
curl -XPOST -H 'apikey: YOUR_API_KEY' 'https://api.inten.to/ai/text/transliterate' -d '{
"context": {
"text": ["こんにちは", "文字変換の例"],
"language": "ja",
"fromscript": "jpan",
"toscript": "latn"
},
"service": {
"provider": "ai.text.transliterate.microsoft.translator_text_api.3-0"
}
}'
If the provider doesn’t have capabilities (e.g. language) to process request, 413 error will be returned:
{
"error": {
"code": 413,
"message": "Provider ai.text.transliterate.microsoft.translator_text_api.3-0 constraint(s) violated: fromscript (Specifies the script used by the input text.), language (Specifies the language of the text to convert from one script to another.), toscript (Specifies the output script.)"
},
"request_id": "..."
}
To get a list of available Dictionary providers, send a GET request to https://api.inten.to/ai/text/transliterate.
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate'
The response contains a list of the providers available for given constraints with an information on using custom models, etc.:
[
{
"production": true,
"integrated": true,
"billable": true,
"own_auth": true,
"stock_model": true,
"custom_model": false,
"delegated_credentials": null,
"async_only": false,
"id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
"name": "Microsoft Translator API v3.0",
"vendor": "Microsoft",
"api_id": "microsofttranslator30",
"picture": "img/api/mcs_translate.png",
"type": "instance",
"description": "Translator API v3.0",
"language": [
"ar",
...
],
"fromscript": [
"latn",
...
],
"toscript": [
"arab",
...
]
}
]
More on provider flags and capabilities.
The list of providers may be further constrained by adding desired parameter values to the GET request:
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate?fromscript=arab'
Response:
[
{
"production": true,
"integrated": true,
"billable": true,
"own_auth": true,
"stock_model": true,
"custom_model": false,
"delegated_credentials": null,
"async_only": false,
"id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
"name": "Microsoft Translator API v3.0",
"vendor": "Microsoft",
"api_id": "microsofttranslator30",
"picture": "img/api/mcs_translate.png",
"type": "instance",
"description": "Translator API v3.0"
}
]
To get information about a provider with a given ID, send a GET request to https://api.inten.to/ai/text/transliterate/PROVIDER_ID.
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate/ai.text.transliterate.microsoft.translator_text_api.3-0'
The response contains a list of the metadata fields and values available for the provider:
{
"id": "ai.text.transliterate.microsoft.translator_text_api.3-0",
"vendor": "Microsoft",
"logo": "https://inten.to/img/api/mcs_translate.png",
"billing": true,
"description": "Translator API v3.0",
"production": true,
"integrated": true,
"billable": true,
"own_auth": true,
"stock_model": true,
"custom_model": false,
"delegated_credentials": null,
"async_only": false,
"auth": {
"key": "YOUR_KEY"
},
"languages": {
"language": [
"ar",
...
],
"fromscript": [
"latn",
...
],
"toscript": [
"arab",
...
]
},
"bulk": true
}
Will return an array of supported languages, for each language:
locale parameter is provided); if there is no localized name, null is returnedcurl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate/languages?locale=ru'
Response:
[
{
"iso_name": "Hebrew",
"intento_code": "he",
"direction": "right-to-left",
"name": "иврит"
},
...
]
For a given language code (intento internal or client’s) will show full metadata:
locale parameter is provided); if there is no localized name, null is returnedcurl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/ai/text/transliterate/languages/he?locale=ru'
Response:
{
"iso_name": "Hebrew",
"intento_code": "he",
"iso_639_1_code": "he",
"iso_639_2t_code": "heb",
"iso_639_2b_code": "heb",
"iso_639_3_code": "heb",
"provider_codes": {},
"name": "иврит"
}
To define your aliases to language codes, send a POST request to Intento API at https://api.inten.to/settings/languages. After 60 seconds, you can start using them.
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/settings/languages' --data '{"aliasforen":"en"}'
Response:
{
"aliasforen": "en"
}
Settings can be retrieved using the GET request
curl -H 'apikey: YOUR_INTENTO_KEY' 'https://api.inten.to/settings/languages'
Response:
{
"aliasforen": "en"
}