Hebrew

Add nikud (vowel points)

Add full nikud to Hebrew text, for vocalized display, learning materials and text-to-speech, where unvocalized Hebrew is ambiguous. English terms and numbers are left untouched.

The result is checked: verified: true means removing the points gives back your text (only the vowel letters ו and י may differ, which does not change pronunciation). When verified is false, nikud is your text unchanged; send it to speech unvocalized or retry.

Quota. Consumes the monthly character quota: the length of text.

Limits. text up to 10,000 characters.

post/v1/nikud

Request

  • Base URL: https://hc.itsbaba.com
  • URL: https://hc.itsbaba.com/v1/nikud
  • Auth: HTTP bearer

Request body

textstring required

Hebrew text to vocalize, up to 10,000 characters. English terms and numbers pass through.

Example request

{
  "text": "שלום עולם"
}

Response

Vocalized text

textstring required

The input.

nikudstring required

The vocalized text, or the input unchanged when verified is false.

verifiedboolean required

True when removing the points gives back exactly the input. When false, nikud is the input unchanged: send it to speech unvocalized or retry.

Example response

{
  "text": "שלום עולם",
  "nikud": "שָׁלוֹם עוֹלָם",
  "verified": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.