Translate text
translateTranslate one text between Hebrew, English, Russian and the other languages from list_languages. Use it for product, support, interface, finance, legal and general clinical text. Returns the translation with its direction metadata.
Protected translation: set protect: true, a domain (general, clinical, finance, legal) or any protection field, and prices, quantities, numbers, dates, codes, identifiers, product names, interface variables ({name}, %s) and protected_terms are kept exactly as written, and every sentence is verified; a sentence that cannot be verified comes back in the source language (status fallback) instead of a wrong value. finance also protects IBANs, card and account numbers and checks credit/debit direction; legal keeps clause references, citations and defined terms and checks shall/may modality; clinical protects drugs, doses and lab values.
Gender: listener_gender is the reader ("you"), speaker_gender the speaker ("I", e.g. an assistant). glossary maps source terms to required renderings; redact_terms keeps names exact and hidden from the model. message_format: "icu" translates an ICU MessageFormat string and rewrites plural branches for Hebrew and Russian. quality: fast, balanced (default) or smartest.
Uses the monthly character quota. For many short strings use translate_batch; for full English clinical documents into Hebrew use clinical_translate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bidi | No | `isolate` wraps protected values in Unicode isolates in Hebrew output. Default none; see /v1/wrap. | |
| text | Yes | Text to translate, 1 to 20,000 characters. Counts toward the monthly character quota. | |
| domain | No | `general` (default) for product, commerce, support and interface text. `clinical` adds clinical register and drug, dose, lab and abbreviation detection. `finance` adds a formal banking register, protects IBANs, SWIFT/BIC codes, bank account numbers (including Israeli bank-branch-account), Israeli ID numbers and card numbers (check digits verified; these values are never shown to the model), invoice, policy and transaction references, signed amounts, rates and basis points, and checks that every money direction (credit/debit, deposit/withdrawal, buy/sell, increase/decrease, gain/loss, who owes whom) is kept. `legal` adds a formal legal register, protects clause and section references (Section 4.2, Clause 7(b), סעיף 12(א), § 3) and case and statute citations, renders each defined term ("the Company") the same way throughout, and checks that modality (shall, may, shall not, is not required to) is kept. Any value implies `protect`. | |
| gender | No | Grammatical gender for the reader where the target language marks it. For assistants, prefer `listener_gender` and `speaker_gender`. | |
| protect | No | Keep prices, quantities, numbers, dates, codes, identifiers, product names, interface variables ({name}, %s) and <keep>…</keep> text exactly as written, and verify every sentence. Implied by any protection field. Hebrew, English and Russian. Account terms switch it on automatically for these pairs. | |
| quality | No | `fast`: lowest latency, for high volume and short strings. `balanced`: the default. `smartest`: maximum nuance for long or sensitive text. | balanced |
| audience | No | Clinical domain register. `clinician` (default) keeps shorthand such as BID and PO; `patient` writes it as plain words. | |
| glossary | No | Source term → required rendering in the target language. Up to 500 entries. Wins over an account term with the same text. | |
| date_order | No | How to read ambiguous numeric dates such as 04/03/2026. Default MDY for English sources, DMY for Hebrew and Russian. | |
| date_style | No | `hebrew` (default) spells the month out in the target language ("4 במרץ 2026", "4 марта 2026 г."); `iso`; `keep` (unambiguous dates only). | |
| source_lang | No | BCP 47 source language, or `auto` (default) to detect it. | |
| target_lang | Yes | BCP 47 target language, e.g. `he`, `en`, `ru`. See GET /v1/languages. | |
| redact_terms | No | Kept exactly and never shown to the model: customer names and other personal data. Up to 200. | |
| transliterate | No | Include a Latin transliteration when the target is Hebrew. | |
| message_format | No | `icu`: the text is an ICU MessageFormat message. The result is a valid ICU message in the target language: arguments ({name}, {count, number}, {d, date, short}) and `#` are kept, plural and selectordinal branches are rewritten for the target language's CLDR categories (Hebrew one, two, other; Russian one, few, many, other; English one, other; exact matches such as =0 kept), and select keys are kept. A plural or select inside a sentence is moved to the top so every branch is a whole sentence; `protection.segments` lists each branch sentence. Always protected; Hebrew, English and Russian. Invalid ICU returns 400 `invalid_message_format`; a message that cannot be verified comes back unchanged with `protection.status: "fallback"`. | |
| patient_gender | No | Clinical domain: gender of a patient referred to in the third person. | |
| speaker_gender | No | Gender of the speaker ("I"), for an assistant or brand voice: מצאתי, я нашла / я нашёл. | |
| listener_gender | No | Gender of the reader ("you"): תרצי / תרצה. Hebrew and Russian mark it; English does not. Without it, Hebrew interface text uses neutral forms. | |
| protected_terms | No | Terms kept exactly as written: product names, brand names, SKUs. Up to 500, each up to 200 characters. Added to the account terms list for this request. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Request identifier. Include it when you contact support. | |
| usage | No | What this request consumed. | |
| source | No | The source text with its directionality metadata. | |
| quality | No | Quality tier used. | |
| translation | No | The translation with its directionality metadata. |