The language of text to map from. Except for languages such as zh-CN and zh-TW, please use the ISO 639-1 code. To get the list of supported languages, please refer to Languages section.

fromText

The text to map from. Up to 255 charaters. About counting, please refer to "Charater Count method" in Count Method.

toLang

The language of the translated text. Except for languages such as zh-CN and zh-TW, please use the ISO 639-1 code. To get the list of supported languages, please refer to Languages section.

toText

The text to map to. Up to 255 charaters. About counting, please refer to "Charater Count method" in Count Method.

Response

Key

Description

status

For successfully adding of an entry, this field will be "success". For unsuccessful requests, this field will be "failure".

Limitation

Only 3 or less words of User Dictionary can be applied in one sentence when using real-time translation engine. For example: "猫"→"Kitty" "犬"→"Marutaro" "ウサギ"→"Peter" "クマ"→"Teddy" When send request below ["これは猫です。それは犬です。ウサギもクマも動物です。", "ウサギもクマも可愛いです。"] The result will be like: ["This is Kitty. It is Marutaro. Both Peter and bears are animals.", "Both Peter and Teddy are cute."] ※For there are 3 user dictionaries:「猫」、「犬」、「ウサギ」are applied in first sentence, 「クマ」 will not be applied.

api/v1/dictionary

Add a new user dictionary entry from "square" to "広場".

JavaScript

type UserDictionaryEntry struct {
  FromLang string `json:"fromLang"`
  FromText string `json:"fromText"`
  ToLang string `json:"toLang"`
  ToText string `json:"toText"`
}

func AddUserDictionaryEntry(basePath string) {
  apiURL := "/api/v1/dictionary"

  requestJson := &UserDictionaryEntry{
      FromLang: "en",
      FromText: "square",
      ToLang: "jp",
      ToText: "広場"}
  jsonValue, _ := json.Marshal(requestJson)

  client := &http.Client{}
  req, err := http.NewRequest(
      "POST",
      GetFullUrl(basePath, apiURL),
      bytes.NewBuffer([]byte(jsonValue)),
  )
  req.Header.Set("Content-Type", "application/json")
  res, err := client.Do(req)

  if err != nil {
      fmt.Printf("The HTTP request failed with error %s\n", err)
  } else {
      data, _ := ioutil.ReadAll(res.Body)
      fmt.Println(string(data))
  }
}

About the authentication, please refer to the authentication section.

You can get a full version of sample codes here