Skip to main content
POST
text.translate

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
text
string
required

The text to translate, at most 5,000 characters.

Required string length: 1 - 5000
targetLanguage
string
required

Language to translate into, lower-case BCP 47 like de, pt-br or zh-hans. Where a source distinguishes them, plain en is served as US English and plain pt as Brazilian Portuguese.

Maximum string length: 24
sourceLanguage
string

Language of the input, lower-case BCP 47 like en. Omit it and the result reports the language detected in the input.

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

Tone of the translation: more leans formal, less leans informal. Applied where the target language supports it; elsewhere the default tone is used. Default default.

Available options:
default,
more,
less

Response

The result

text
string
required

The translated text.

detectedLanguage
any

Language detected in the input, lower-case BCP 47. Present when sourceLanguage was not sent.