Skip to content

docs(document): add enable_watermark parameter to POST /v2/document#398

Open
yoshiamakino wants to merge 1 commit into
DeepL:mainfrom
yoshiamakino:docs/document-enable-watermark
Open

docs(document): add enable_watermark parameter to POST /v2/document#398
yoshiamakino wants to merge 1 commit into
DeepL:mainfrom
yoshiamakino:docs/document-enable-watermark

Conversation

@yoshiamakino

Copy link
Copy Markdown
Contributor

What

Documents the enable_watermark request parameter on POST /v2/document, which is already live in the API but missing from the reference.

When set to true, a "Translated by DeepL" watermark is applied to the translated output document.

Changes

  • Add enable_watermark (boolean, default false) to the multipart request body of POST /v2/document in both api-reference/openapi.yaml (source) and api-reference/openapi.json (generated).
  • Add a Watermark usage example alongside the existing Basic/Glossary examples.

Notes

  • The parameter is only honored for docx and pdf output; for other formats it is ignored and the document is returned without a watermark. This is stated in the parameter description.
  • The .mdx page needs no change — it renders from the OpenAPI spec.

🤖 Generated with Claude Code

Document the enable_watermark request parameter for document translation.
When true, a "Translated by DeepL" watermark is applied to the translated
output. Supported for docx and pdf output only; ignored for other formats.

Adds the property to both the YAML source and generated JSON specs, plus a
Watermark usage example.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant