Skip to content

Add your DeepL key

This is where you store your DeepL API key. Add at least one key before you can translate anything.

Open it from: DeepL → Credentials


The credentials page

DeepL Credentials list

Each row in the list shows one key:

  • Label — the name you gave it.
  • Default — whether this is the key used for automatic translation.
  • Status — on or off.

You can search by label, sort columns, or click Filter to narrow the list. The pencil icon edits a row, the trash icon deletes it.


Add a key

Click + Add Credential in the top-right corner.

Add credential popup

Fill in:

  • Label — any name you want, e.g. Production.
  • API Key — paste your DeepL key.

Click Save.

The extension checks the key with DeepL before saving. If the key is wrong you'll see an error and nothing is stored.

After saving, you land on the edit page where you can switch on auto-translate.


Edit a key

Click the pencil icon on any row.

Edit credential page

The page has two tabs at the top — General (shown above) and History. General is split into four panels.

Credential

  • Label — change the name.
  • API Key — leave blank to keep your current key. Type a new one to replace it.

Settings (top right)

SwitchWhat it does
StatusTurn the key on or off. Off keys are ignored everywhere.
DefaultOnly one key can be the default. The default key is used for automatic translation.
Enable Auto TranslateTurn on automatic translation after import / save.
Replace Existing ValueWhen on, auto-translate overwrites target values that are already filled. Off keeps existing values intact.

Mapping (only on the default key, when auto-translate is on)

Tell the extension which language to translate from and into:

  • Source channel + Source locale — where the original text lives.
  • Target channels + Target locales — where translations should be saved.

Attribute Mapping (right side, next to Mapping)

By default, auto-translate covers every AI-translatable text or textarea attribute on the product (i.e. any attribute with AI Translate ticked — see Mark fields).

If you only want auto-translate to touch a few of those attributes, pick them in Attributes to auto-translate. Leave the field empty to keep the default behaviour.

This only narrows the list — it can't add attributes that aren't flagged AI Translate.

Click Save when done.


Test the key

The edit page has a Test Connection button. Click it any time to check the key still works and see how much of your DeepL quota you've used.


Delete a key

Click the trash icon on a row and confirm.

You can't delete the only working default key. Mark another key as default first.


See change history

The edit page has a History tab that lists every change made to this key — label edits, status flips, mapping changes. Your API key itself is never shown there.

See change history

Released under the MIT License.