Skip to content

Commit 6ab15f9

Browse files
authored
Merge pull request #404 from DeepL/docs/restore-enable-watermark
docs(document): restore enable_watermark for POST /v2/document
2 parents fba0c94 + c732075 commit 6ab15f9

3 files changed

Lines changed: 31 additions & 0 deletions

File tree

‎api-reference/openapi.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1077,6 +1077,14 @@
10771077
"file": "@document.docx"
10781078
}
10791079
},
1080+
"Watermark": {
1081+
"summary": "Adding a \"Translated by DeepL\" watermark (docx/pdf only)",
1082+
"value": {
1083+
"target_lang": "DE",
1084+
"file": "@document.pdf",
1085+
"enable_watermark": true
1086+
}
1087+
},
10801088
"Glossary": {
10811089
"summary": "Using a Glossary",
10821090
"value": {
@@ -1169,6 +1177,11 @@
11691177
"translation_memory_threshold": {
11701178
"$ref": "#/components/schemas/TranslationMemoryThreshold"
11711179
},
1180+
"enable_watermark": {
1181+
"description": "When `true`, adds a \"Translated by DeepL\" watermark to the translated document.\n\nOnly supported for `docx` and `pdf` output. For all other output formats the parameter is ignored and the document is returned without a watermark.",
1182+
"type": "boolean",
1183+
"default": false
1184+
},
11721185
"enable_beta_languages": {
11731186
"description": "This parameter is maintained for backward compatibility and has no effect.",
11741187
"type": "boolean",

‎api-reference/openapi.yaml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -827,6 +827,12 @@ paths:
827827
value:
828828
target_lang: DE
829829
file: '@document.docx'
830+
Watermark:
831+
summary: Adding a "Translated by DeepL" watermark (docx/pdf only)
832+
value:
833+
target_lang: DE
834+
file: '@document.pdf'
835+
enable_watermark: true
830836
Glossary:
831837
summary: Using a Glossary
832838
value:
@@ -925,6 +931,13 @@ paths:
925931
$ref: '#/components/schemas/TranslationMemoryId'
926932
translation_memory_threshold:
927933
$ref: '#/components/schemas/TranslationMemoryThreshold'
934+
enable_watermark:
935+
description: |-
936+
When `true`, adds a "Translated by DeepL" watermark to the translated document.
937+
938+
Only supported for `docx` and `pdf` output. For all other output formats the parameter is ignored and the document is returned without a watermark.
939+
type: boolean
940+
default: false
928941
enable_beta_languages:
929942
description: |-
930943
This parameter is maintained for backward compatibility and has no effect.

‎docs/resources/roadmap-and-release-notes.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ rss: true
1313
## July 16 - Combined Status Page
1414
- DeepL now publishes a single [status page](https://www.deeplstatus.com) covering all services, with a dedicated [API view](https://www.deeplstatus.com/?tab=api) for real-time API status and incidents.
1515

16+
## July 14 - Watermarking for Document Translation
17+
- [`POST /v2/document`](/api-reference/document/upload-and-translate-a-document) now accepts an `enable_watermark` parameter. When set to `true`, a "Translated by DeepL" watermark is applied to the translated document.
18+
- Supported for `docx` and `pdf` output only; the parameter is ignored for all other formats.
19+
- See the [document translation](/api-reference/document#request-body-descriptions) overview page for parameter details.
20+
1621
## July 7 - New Document Formats and Higher File Size Limits
1722
- [`POST /v2/document`](/api-reference/document/upload-and-translate-a-document) now supports five additional file formats: `idml` (Adobe InDesign), `xml`, `json`, `dita` (DITA topics), and `mif` (Adobe FrameMaker).
1823
- XLIFF support has been expanded to versions 1.2, 2.0, and 2.1 (previously 2.1 only).

0 commit comments

Comments
 (0)