From 59899299a21bf70af9af370ebccd926ad611add9 Mon Sep 17 00:00:00 2001 From: Maxim Brunnmeier Date: Tue, 15 Sep 2026 10:49:54 +0200 Subject: [PATCH] docs: add style_profile_id to POST /v2/document The document endpoint takes the same style profile parameter as text translation. The profile is applied once the document's source language is known; it cannot be combined with the individual customization parameters (400), and accounts without style profiles get a 403. --- api-reference/openapi.json | 6 ++++++ api-reference/openapi.yaml | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+) diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 3ecf5af4..79373f58 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -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", diff --git a/api-reference/openapi.yaml b/api-reference/openapi.yaml index e7be6fc1..899049fa 100644 --- a/api-reference/openapi.yaml +++ b/api-reference/openapi.yaml @@ -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.