Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions api-reference/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -1210,6 +1210,12 @@
"translation_memory_threshold": {
"$ref": "#/components/schemas/TranslationMemoryThreshold"
},
"style_profile_id": {
"description": "Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,\nstyle rule lists, translation memories and example documents through one ID. The profile is applied\nonce the document's source language is known: the glossaries with a dictionary for the language\npair, the style rule list for the target language, the translation memories whose source language\nmatches the document, and the example documents written in the target language. A component that\ndoes not fit the language pair is left out; this is not an error.\n\nA style profile is a complete set of customizations, so it cannot be combined with `glossary_id`,\n`glossary_ids`, `style_id`, `translation_memory_id` or `translation_memory_threshold`. A request\nthat combines them is rejected with `400 Bad Request`. A style profile that does not exist or that\nyour account cannot access fails the document translation.\n\nAvailable for accounts with style profiles enabled; otherwise the request is rejected with\n`403 Forbidden`.",
"type": "string",
"format": "uuid",
"example": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"
},
"enable_watermark": {
"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.",
"type": "boolean",
Expand Down
19 changes: 19 additions & 0 deletions api-reference/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1016,6 +1016,25 @@ paths:
$ref: '#/components/schemas/TranslationMemoryId'
translation_memory_threshold:
$ref: '#/components/schemas/TranslationMemoryThreshold'
style_profile_id:
description: |-
Translate with a [style profile](/api-reference/style-profiles/get-style-profile): its glossaries,
style rule lists, translation memories and example documents through one ID. The profile is applied
once the document's source language is known: the glossaries with a dictionary for the language
pair, the style rule list for the target language, the translation memories whose source language
matches the document, and the example documents written in the target language. A component that
does not fit the language pair is left out; this is not an error.

A style profile is a complete set of customizations, so it cannot be combined with `glossary_id`,
`glossary_ids`, `style_id`, `translation_memory_id` or `translation_memory_threshold`. A request
that combines them is rejected with `400 Bad Request`. A style profile that does not exist or that
your account cannot access fails the document translation.

Available for accounts with style profiles enabled; otherwise the request is rejected with
`403 Forbidden`.
type: string
format: uuid
example: 3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47
enable_watermark:
description: |-
When `true`, adds a "Translated by DeepL" watermark to the translated document.
Expand Down