MaillyDocs

Translate text segments of an email

POST
/inbox/messages/{id}/translations

Used by the web inbox, which splits the rendered email into segments. Segments already translated are served from the cache for free; the rest are translated by the translation model and charged to the model usage balance. At most 60 segments and 12000 characters per request.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Mailly API key(Authorization: Bearer )

Path Parameters

id*string

Request Body

application/json
  1. body
target*string
Value in"zh-CN""zh-TW""en""ja""ko""es""fr""de""pt""ru""it""vi"
segmenter_version*integer
Range-9007199254740991 <= value <= 9007199254740991
subject?string
Lengthlength <= 1000
segments*array<>
Itemsitems <= 60

Response Body

Translated text

application/json
  1. response
success*boolean
target_language*string
source_language*string|null
subject*string|null
segments*

Translated text keyed by segment hash

[key: string]?unknown
curl -X POST 'https://api.mailly.site/inbox/messages/string/translations' \  -H 'Content-Type: application/json' \  -d '{  "target": "zh-CN",  "segmenter_version": -9007199254740991,  "segments": [    {      "hash": "string",      "text": "string"    }  ]}'
{  "success": true,  "target_language": "string",  "source_language": "string",  "subject": "string",  "segments": {    "property1": "string",    "property2": "string"  },  "property1": null,  "property2": null}