Skip to main content

DeepL Translate tool

The DeepL Translate tool translates untranslated block content with the DeepL API. The provider is fixed by the tool name, so there is no provider field — only the DeepL credential applies. A target language is required and a DeepL API key must be supplied (resolved from the OS keychain by the CLI, or set inline in a recipe step).

Blocks that carry inline codes are round-tripped through semantic HTML so DeepL preserves the tags natively, then reconstructed from the response. With a session cache, targets already translated in a previous run are reused, so repeat runs skip blocks that are already done. When constructed without credentials the tool falls back to an offline demo provider so it remains listable and runnable for illustration.

IDdeepl-translate
SourceBuilt-in
Categorytranslation
Cardinalitybilingual
Requirestarget-language, credentials
Tagsmt, machine-translation

Parameters

ParameterTypeDefaultDescription
apiKeystringAPI key for the MT provider
emailstringAccount email for higher rate limits (mymemory)
projectIdstringGoogle Cloud project ID (google)
regionstringAzure region (microsoft)
subscriptionKeystringAzure subscription key (microsoft)

Configure these parameters interactively and copy the flow-step YAML on the Tool Reference.

Examples

Translate with DeepL

Translate untranslated blocks using a DeepL API key.

apiKey: your-deepl-key

Processing notes

  • Operates on translatable blocks with non-empty source; other parts pass through unchanged.

  • Blocks with inline codes round-trip through semantic HTML so tags survive translation.

  • With a session cache, already-translated targets are reused and fresh translations are cached.

Limitations

  • Requires a target language and a DeepL API key; without a key the tool runs the offline demo provider, not DeepL.

  • DeepL makes a network round-trip per block; cost and latency scale with content volume.

  • The provider is fixed to DeepL by the tool name and cannot be changed through configuration.

← Back to the Tool Reference