SieloTech API docs

Furigana

The Furigana API allows you to add reading aids to Japanese text. In the end, many will probably aim at learning to read without them, but there are some reasons why one might want to use furigana:

  • The learning process can be very frustrating if one doesn't know the reading of a lot of common kanji or they have just started.
  • A person may need to be able to read Japanese for practical purposes without aiming at reading kanji without aids in the long term.
  • Accessibility or low vision issues (subtle differences of some kanji may be more difficult to identify).
  • Probably other reasons I haven't thought of.

API Endpoint

POST api.sielotech.com/furigana

Authentication

All SieloTech APIs require authentication. Please refer to the Authentication page for details on how to authenticate your requests.

Request Parameters

The API accepts a JSON body with the following parameters:

ParameterTypeRequiredDescription
textstringYesThe Japanese text for which to generate furigana
modeenumNoOutput format: "list" (default) or "dictionary"

Example Request

POST api.sielotech.com/furigana

headers: {
  "Authorization": "8d9745db-98ba-4279-86ac-025b865ae656",
  "Content-Type": "application/json"
}
body: {
  "text": "日本語の文章",
  "mode": "list"
}

Response Formats

The API supports two output formats controlled by the mode parameter:

List Mode (Default)

Returns an object with a "text" property containing a list of words with their readings. For words containing kanji, a two-element array is provided with the original word and its reading.

{
  "text": [
    ["日本語", "にほんご"],
    ["の"],
    ["文章", "ぶんしょう"]
  ]
}

Dictionary Mode

Returns an object with a "text" array containing all words and a "furigana" object mapping words to their readings. Only the words containing kanji are included in the "furigana" dictionary.

{
  "text": ["日本語", "の", "文章"],
  "furigana": {
    "日本語": "にほんご",
    "文章": "ぶんしょう"
  }
}

Error Handling

For information on how errors are handled across all SieloTech APIs, including status codes and error formats, please refer to the Error Handling page.