---
title: "Add nikud (vowel points)"
method: POST
path: "/v1/nikud"
tags: ["Hebrew"]
---

# Add nikud (vowel points)

`POST /v1/nikud`

## Request

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

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.

## Request body

- NikudRequest
  - `text` string, required: Hebrew text to vocalize, up to 10,000 characters. English terms and numbers pass through.

## Response `200`

Vocalized text

- NikudResponse
  - `text` string, required: The input.
  - `nikud` string, required: The vocalized text, or the input unchanged when `verified` is false.
  - `verified` boolean, 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.

## Other responses

- `400`: Invalid request: the body failed validation or a value is out of range.
- `401`: Missing, malformed, invalid or revoked API key.
- `402`: A new self-serve account must save a card in the console before it can use the API. Adding a card is free.
- `403`: The connection used TLS older than 1.2.
- `429`: Too many requests this minute (`rate_limited`), or the monthly character quota is used up (`quota_exceeded`). Retry `rate_limited` after a short wait; `quota_exceeded` lasts until the quota resets or the plan changes.
- `500`: Unexpected server error. Safe to retry.
- `502`: The model provider failed or returned an empty result. Nothing was charged. Safe to retry.
- `503`: A model feature is temporarily unavailable.

---

[API](https://skmtc.dev/itsbaba/apis/hebrewcore-api.md) · [All operations](https://skmtc.dev/itsbaba/apis/hebrewcore-api/llms.txt) · [OpenAPI document](https://skmtc.dev/itsbaba/apis/hebrewcore-api/revisions/f54229695236?raw)