Skip to main content
POST
text.translate-custom

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by text.glossary.create or text.glossary.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
text
string
required

Text to translate, at most 5,000 characters.

Required string length: 1 - 5000
sourceLanguage
string
required

Source language; required when applying a glossary.

Maximum string length: 24
targetLanguage
string
required

Target language.

Maximum string length: 24
formality
enum<string>
default:default

Requested tone; default default.

Available options:
default,
more,
less
context
string

Context used to disambiguate the text; not translated.

Required string length: 1 - 5000
preserveFormatting
boolean
default:false

Preserve formatting where supported; default false.

model
enum<string>
default:default

Explicit model preference; default default.

Available options:
default,
quality,
latency

Response

The result

text
string
required

Translation with your preferred terms applied.