DeepL

DeepL provides high-quality machine translation with support for formality preferences in supported languages.

Installation

Add the DeepL dependency to your build:

Requirements

Requires Brightspot 5.0 or later.

Maven

<dependency>
    <groupId>com.brightspot.translation</groupId>
    <artifactId>deepl</artifactId>
    <version>__HIDDEN__</version>
</dependency>

Gradle

implementation 'com.brightspot.translation:deepl:__HIDDEN__'

Gradle (Kotlin DSL)

implementation("com.brightspot.translation:deepl:__HIDDEN__")

Prerequisites

Before configuring DeepL in Brightspot:

• DeepL API Account — You need a DeepL account with an API plan (Free or Pro)
• API Key — Create an authentication key in your DeepL account settings

Free vs. Pro

DeepL offers both Free and Pro API plans. The Free plan has a monthly character limit of 500,000 characters. The Pro plan offers higher limits and priority access. Both plans use the same API — only the authentication key differs.

Configuration

To configure DeepL:

1. Click > Admin > Sites & Settings.

2. Under the CMS tab, expand the Translation cluster.

3. Under Default Service Settings, click Add Item.

4. Select DeepL from the service type dropdown.

5. Configure the following fields:

   Field	Description
   Name	Optional display name for this configuration
   API Key	Your DeepL API authentication key
   Formality	(Optional) Formality preference for translations

6. Click Save.

warning

API keys are sensitive credentials. Ensure only administrators have access to this configuration.

Per-type configuration

You can also configure DeepL for specific content types instead of (or in addition to) the default. Under Type Settings, add a type setting, select the content types it applies to, and add a DeepL service settings entry under that type setting's Service Settings list.

Formality

DeepL supports formality preferences for certain target languages (such as German, French, Spanish, and others). The available options are:

Option	Description
Default	Use the default formality for the target language
More	Use formal language (e.g., formal "you" pronouns)
Less	Use informal language
Prefer More	Use formal language when available, otherwise default
Prefer Less	Use informal language when available, otherwise default

The "Prefer" options are recommended over "More" and "Less" because they gracefully handle languages that don't support formality distinctions.

Completing setup

After configuring DeepL, complete the general translation configuration to:

• Set available locales
• Configure completion actions
• Enable translation for specific content types

See Also

• Configuration — General translation settings
• Translating Content — How to send content for translation