What are the parameters when submitting a name-translation request?

The Name Translation REST endpoint is: https://api.rosette.com/rest/v1/name-translation

The name translation endpoint transliterates the name of an entity (Person, Location, or Organization) from English to another language, or to English from another language.

When you are converting from English to another language, the endpoint is optimized to convert the English version of a person’s name back to the native language of that name. For example, you can translate Vladimir Nabokov into Russian (rus) and the endpoint returns "translation": "Владимир Набоков".

 

Request Fields

You must specify the name and the targetLanguage for the translation when you submit a request to the /name-translation endpoint.

For example, to translate “بدر شاكر السياب” from Arabic to English, “Badr Shakir al-Sayyab”, you would use the values in the Example column.

Field	Description	Value	Example
name	Name to translate	String	“بدر شاكر السياب”
targetLanguage	Translate name into this language	3-letter language code	eng

Optionally, you can include any of the following fields:

Field	Description	Value	Example
entityType	The type of name	PERSON (default), LOCATION, or ORGANIZATION	PERSON
sourceScript	Script of the name as in the input	4-letter script abbr.	Arab
sourceLanguageOfOrigin	Native language the name originates in	3-letter language code	ara
sourceLanguageOfUse ¹	Language of the name as in the input	3-letter language code	ara
targetScript	Translate name into this script	4-letter script abbr.	Latn
targetScheme	(ADVANCED USE ONLY) Scheme for transliteration	Translit. scheme abbr.	IC

 ¹ We recommend that you include sourceLanguageOfUse for optimal results, if you know the value. If you do not specify the language, then Rosette detects it using an algorithm specific to names.

 

Head to our documentation for more information about the request parameters.