Languages
Translate
Translates one rich text body (sys_content_rich) into language_target through DeepL, auto-detecting the source when language_source is left empty and reporting the detected code back on the response. Both codes must come from the translation languages endpoint, and specifying a source without a target is rejected.
Identical requests are served from a two day cache instead of calling DeepL again, and sys_attachments are echoed back unchanged apart from freshly signed download URLs.
POST
/api/{tenant:minlength(2)}/v{version:apiVersion}/languages/translate
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_translation
- Wrapper
- DTO_response_wrap
- Other statuses
- 403 (Forbidden)
Response body example
DTO_translation
| Name | Type | ReadOnly | Description |
|---|
| language_source | String | | Language code of the content sent in, left empty to let the translation service detect it, and it must be a code enabled as source language |
| language_target | String | | Language code to translate into, required, and EN is treated as EN-US |
| sys_content_rich | DTO_rich_text | | The rich text to translate on the request, and the translated rich text on the response |
| sys_attachments | DTO_reference_attachment[] | | Returned exactly as sent in, enriched with download URLs on the way back |
DTO_rich_text
| Name | Type | ReadOnly | Description |
|---|
| plain_preview | String | ReadOnly | Plain preview |
| html | String | | Html |
| editorjs | DTO_editorjs | | Editorjs |
| tiptap | DTO_tiptap | | Tiptap |
| read_minutes | Int32 | | Read minutes |
DTO_editorjs
| Name | Type | ReadOnly | Description |
|---|
| time | Int64 | | Time |
| version | String | | Version |
| blocks | DTO_editorjs_block[] | | Blocks |
DTO_editorjs_block
| Name | Type | ReadOnly | Description |
|---|
| id | String | | Id |
| type | String | | Type |
| data | Object | | Data |
DTO_tiptap_attrs
| Name | Type | ReadOnly | Description |
|---|
| textAlign | String | | Textalign |
| level | Int32 (nullable) | | Level |
| checked | Boolean (nullable) | | Checked |
| id | Int32 (nullable) | | Id |
| alt | String | | Alt |
| title | String | | Title |
| width | String | | Width |
| wrapperStyle | String | | Wrapperstyle |
| files | DTO_tiptap_file_ref[] | | Files |
| href | String | | Href |
| target | String | | Target |
| colspan | Int32 (nullable) | | Colspan |
| rowspan | Int32 (nullable) | | Rowspan |
| color | String | | Color |
| text | String | | Text |
| name | String | | For emoji |
| native | String | | For emoji |
DTO_tiptap_file_ref
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | Id |
| label | String | | Label |
DTO_reference_attachment
| Name | Type | ReadOnly | Description |
|---|
| size_kb | Int32 | ReadOnly | Size kb |
| status | ENUM attachment_status | ReadOnly | Status |
| status_message | String | ReadOnly | Status message |
| download_url | String | ReadOnly | Download url |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM attachment_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | UNAVAILABLE | UNAVAILABLE, processing in progress |
| 2 | OK | OK |
| 3 | WARNING | WARNING |
| 4 | ERROR | ERROR |
Generated Aug 4, 2026 18:37
