# HebrewCore API

> HebrewCore by baba Hebrew (https://itsbaba.com) is a REST API for products that work in Hebrew: translation between Hebrew, English, Russian and more; protected translation that keeps prices, names, codes, numbers and dates exact, with general, finance, legal and clinical domains; ICU plural messages; account terms; render-ready RTL/LTR display; language detection for code-switched input; transliteration; nikud; and the Clinical API. Solution guides cover commerce, customer support, app localization, finance, legal, education and healthcare.

Base URL: https://hc.itsbaba.com. Authenticate every request (except GET /v1/health) with `Authorization: Bearer hc_live_…`. Requests and responses are JSON. Errors use `{ "error": { "type", "message", "code" } }`. Every link below is a Markdown file; https://hc.itsbaba.com/llms-full.txt has all of them plus the full API reference in one file.

## Getting Started

- [Introduction](https://hc.itsbaba.com/docs/intro.md): HebrewCore by baba Hebrew is the language layer for products that work in Hebrew.
- [Quickstart](https://hc.itsbaba.com/docs/quickstart.md): Create a key, send it as a bearer token, and make a first call with curl, Node or Python.
- [Authentication](https://hc.itsbaba.com/docs/auth.md): Machine-to-machine requests authenticate with an API key sent as a bearer token.
- [Dashboard Sign-In](https://hc.itsbaba.com/docs/dashboard-signin.md): Sign in to the dashboard with an email one-time code; access is by invitation.
- [Playground](https://hc.itsbaba.com/docs/playground.md): Try the API in the browser after email sign-in, on your own quota and rate limit, up to 4,000 characters per request.

## AI Agents

- [MCP Server](https://hc.itsbaba.com/docs/mcp.md): A remote MCP server at https://hc.itsbaba.com/mcp that gives AI agents every HebrewCore capability as tools, authenticated with your API key, with setup for Claude Code, Claude Desktop, Cursor, VS Code and the OpenAI API.

## Core Concepts

- [Directionality](https://hc.itsbaba.com/docs/directionality.md): The defining feature of HebrewCore is structured directionality.
- [Protected Values](https://hc.itsbaba.com/docs/protection.md): Which values protected translation keeps exactly: numbers, prices, dates, identifiers, interface variables, your terms and clinical terms.
- [Domains](https://hc.itsbaba.com/docs/domains.md): The four domains (general, finance, legal, clinical): what each protects and which extra checks it runs.
- [Quality Tiers](https://hc.itsbaba.com/docs/quality.md): Translation and transliteration accept an optional `quality` parameter that trades latency for depth.
- [Rate Limits & Quotas](https://hc.itsbaba.com/docs/limits.md): Per-minute rate limits, the monthly character quota, request size limits, and the usage, rate-limit and timing response headers.
- [Plans & Pricing](https://hc.itsbaba.com/docs/pricing.md): Five plans with the same features, 600 requests per minute and 2,000 protected terms; they differ only in monthly characters. Characters are counted with a weight per endpoint and quality tier. Every plan is by inquiry.
- [Errors](https://hc.itsbaba.com/docs/errors.md): The error envelope, every HTTP status and error type, and the finer-grained error codes.
- [Privacy](https://hc.itsbaba.com/docs/privacy.md): Request and response text is never stored, only usage counts; model calls go to the provider with storage turned off.

## Translation

- [POST /v1/translate](https://hc.itsbaba.com/docs/translate.md): Translate text and attach directionality metadata to both the source and the result.
- [Protected Translation](https://hc.itsbaba.com/docs/protected.md): Add any of the fields below to `/v1/translate` or `/v1/translate/batch` to translate with protected values.
- [Account Terms](https://hc.itsbaba.com/docs/terms.md): A persistent per-account list of names (drug, product and brand names) kept exactly in every protected translation, managed with GET/POST /v1/terms and DELETE /v1/terms/{id}.
- [POST /v1/translate/batch](https://hc.itsbaba.com/docs/batch.md): Translate many strings to one target language in a single request, for example to localize a set of UI strings or content fields.
- [App Localization: ICU Plurals](https://hc.itsbaba.com/docs/icu.md): message_format: icu translates ICU MessageFormat strings and rewrites plural branches for Hebrew (one/two/other) and Russian (one/few/many/other).
- [POST /v1/transliterate](https://hc.itsbaba.com/docs/transliterate.md): Transliterate between scripts.

## Display & Detection

- [POST /v1/analyze](https://hc.itsbaba.com/docs/analyze.md): Directionality only, with no language model.
- [POST /v1/wrap](https://hc.itsbaba.com/docs/wrap.md): Render-ready bidirectional output for a display line.
- [POST /v1/detect](https://hc.itsbaba.com/docs/detect.md): Detect the dominant language, script and base direction of a string, with a segment per language (no model).

## Hebrew Text

- [POST /v1/nikud](https://hc.itsbaba.com/docs/nikud.md): Add full nikud (vowel points) to Hebrew text: for vocalized display, learning materials, and text-to-speech, where unvocalized Hebrew is ambiguous.
- [POST /v1/strip-nikud](https://hc.itsbaba.com/docs/strip-nikud.md): Remove nikud, dagesh, and cantillation marks (keeping punctuation like the maqaf).

## Solutions

- [Solutions](https://hc.itsbaba.com/docs/solutions.md): Seven industry guides: commerce, support, app localization, finance, legal, education and healthcare, with the fields to use, examples and pitfalls.
- [Commerce & Marketplaces](https://hc.itsbaba.com/docs/solution-commerce.md): Translate listings and catalogs with product names, prices and SKUs exact, and render price lines correctly in Hebrew.
- [Customer Support](https://hc.itsbaba.com/docs/solution-support.md): Answer customers in Hebrew and Russian with the assistant's and the customer's gender right and every amount, date and order number unchanged.
- [App Localization](https://hc.itsbaba.com/docs/solution-localization.md): Localize string files with ICU plurals, interface variables, a glossary and gender-aware forms.
- [Finance & Banking](https://hc.itsbaba.com/docs/solution-finance.md): Translate statements and notices with domain finance: accounts, IBANs, card numbers and amounts locked, and credit/debit direction checked.
- [Legal & Contracts](https://hc.itsbaba.com/docs/solution-legal.md): Translate contracts and notices with domain legal: clause references, defined terms and citations kept, and shall/may modality checked.
- [Education & Publishing](https://hc.itsbaba.com/docs/solution-education.md): Add nikud for learners and speech, transliterate for beginners, and translate lessons with the learner's gender right.
- [Healthcare](https://hc.itsbaba.com/docs/solution-healthcare.md): Clinical translation with domain clinical on translate, or the Clinical API for streaming, record search and verification.

## Guides

- [Guide: Localizing an App or Site](https://hc.itsbaba.com/docs/guide-localization.md): Translate interface strings with variables, a glossary and gender-aware forms using the batch endpoint.
- [Guide: Mixed-Direction Display](https://hc.itsbaba.com/docs/guide-display.md): Render Hebrew lines with prices, ranges and codes correctly with /v1/wrap in the right format for each surface.
- [Guide: Assistants and Chat](https://hc.itsbaba.com/docs/guide-assistants.md): Detect the user language, then translate assistant replies with protected translation, speaker and listener gender.
- [Guide: Voice Output](https://hc.itsbaba.com/docs/guide-voice.md): Vocalize Hebrew with /v1/nikud before sending it to a text-to-speech engine.
- [Guide: Regulated Content](https://hc.itsbaba.com/docs/guide-regulated.md): Keep amounts, dates, codes and negations exact in finance, insurance, legal and health content.

## Clinical API

- [Clinical API](https://hc.itsbaba.com/docs/medical.md): Clinical endpoints for health products: verified English-to-Hebrew translation, streaming, Hebrew record-search queries and verification.
- [Access & Data Handling](https://hc.itsbaba.com/docs/medical-access.md): How Clinical API access is enabled, the medical scope, server-only calls, and how patient data is handled.
- [POST /v1/medical/translate](https://hc.itsbaba.com/docs/medical-translate.md): Translate a complete English text.
- [WebSocket /v1/medical/stream](https://hc.itsbaba.com/docs/medical-stream.md): For an answer your model is still generating.
- [POST /v1/medical/translate/stream](https://hc.itsbaba.com/docs/medical-sse.md): Same body as `/v1/medical/translate`, answered as Server-Sent Events so the first sentence can be shown before the last is done.
- [POST /v1/medical/query](https://hc.itsbaba.com/docs/medical-query.md): Turn a Hebrew question into an English query for your record search.
- [POST /v1/medical/verify](https://hc.itsbaba.com/docs/medical-verify.md): Check Hebrew that was produced some other way, for example by your own model answering in Hebrew, against its English source.

## Reference

- [GET /v1/languages](https://hc.itsbaba.com/docs/languages.md): List supported languages with display names and direction.
- [GET /v1/health](https://hc.itsbaba.com/docs/health.md): Liveness and database check.
- [Status & Uptime](https://hc.itsbaba.com/docs/status.md): Live status, 90-day uptime and incident history at hc-status.itsbaba.com, with a JSON endpoint and an Atom feed for monitoring.
- [Machine-Readable Discovery](https://hc.itsbaba.com/docs/discovery.md): Standard files that let crawlers, API catalogs and AI agents find the API: an RFC 9727 API catalog, APIs.json, OpenAPI, llms.txt, robots.txt and a sitemap.

## API reference

- [OpenAPI 3.1 document](https://hc.itsbaba.com/openapi.json): the machine-readable contract for every endpoint, with field descriptions, examples, headers and errors
- [Interactive API reference](https://hc.itsbaba.com/reference): browse and try every endpoint in the browser
- [Full documentation and API reference](https://hc.itsbaba.com/llms-full.txt): everything on this list in one Markdown file
- [API catalog](https://hc.itsbaba.com/.well-known/api-catalog): RFC 9727 linkset pointing to the OpenAPI document, docs, status and the MCP server
- [apis.json](https://hc.itsbaba.com/apis.json): APIs.json index of the API and its resources

## Optional

- [Whole documentation as one file](https://hc.itsbaba.com/docs.md): the docs page without the generated API reference