Skip to content

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

Open
yoshiamakino wants to merge 3 commits into
mainfrom
docs/document-enable-watermark
Open

docs(document): add enable_watermark parameter to POST /v2/document#399
yoshiamakino wants to merge 3 commits into
mainfrom
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 api-reference/openapi.yaml.
  • Add a Watermark usage example alongside the existing Basic/Glossary examples.
  • openapi.json is regenerated from the YAML by the Update OpenAPI JSON files from YAML sources workflow.

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.
  • Opened from a branch in this repo (not a fork) so the JSON-conversion workflow can run.

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview Jul 14, 2026, 8:40 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟡 Building Jul 14, 2026, 8:39 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

yoshiamakino and others added 3 commits July 14, 2026 10:12
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>
Watermarking only applies to docx/pdf output; the other examples already
use docx, so show pdf here to make the supported formats clear.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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