Connect your Hygraph project to DeepL

DeepL is an advanced machine translation service that uses artificial intelligence and neural networks to provide highly accurate translations.

#What you can do with the Hygraph-DeepL integration

With the Hygraph-DeepL integration, editorial teams can translate the localized fields in a content entry with a single click.

#Prerequisites to use this integration

You must have a Hygraph account. If you don't have one, you can create one here.
You must have a Hygraph project.
You must have a DeepL account. If you don't have one, you can create one here.
You must have a DeepL API Key.

Apps are environment specific. This means their configuration is applied per environment. Take this into consideration if you're working with a project using more than one environment.

#Install the DeepL app

Click here to install the DeepL App on Hygraph, then follow these steps:

Use the dropdowns to select which project and environment you want to install the app in, then click on Install app.
The permissions pop-up will display. Click on Authorize app to continue. You will be redirected to the configuration screen.
Fill in the API Key on the Configure DeepL screen and click Validate.
After the system validates the API Key, you need to map locales. Use the dropdowns to select the DeepL target languages that match your Hygraph locales. You can also click Auto map to do this automatically.
Click Update to save the mapped locales and finalize the installation process.

#Add DeepL to the sidebar of a model

Navigate to the Schema builder and select the model you want to add the widget to.
Select the Sidebar tab.
Click on the DeepL translate card on the right sidebar.
Give the sidebar widget a display name. You can also optionally give it a description.
Click Add to save.

If you now go to the Content editor, find the view for that model, and open a content entry, you will see the DeepL sidebar widget to the right of the screen.

The widget automatically shows all locales that are the active and shown for that entry. You can select which locales to translate by using the Localizations sidebar widget to show or hide locales.

#Translate content with DeepL

DeepL allows you to automatically translate the localized field in your content entry with one click.

Simply click Translate all on your DeepL sidebar widget located to the right of the screen. If the localized fields already contain a translation, the DeepL translation will overwrite it. A warning indicating this will display, and you need to click Yes, translate to continue.

Pro Tip

The DeepL app automatically detects the locales that you have set as active and shown for the content entry.

You can select which locales to translate by using the Localizations sidebar widget to show or hide locales.

After a few seconds, the localized fields will become populated with the translations, one by one.

Once the translation is finished, a success message will display if there were no errors. If there were any errors, the message will indicate which locales were affected.

#Troubleshooting

Check that the widget has been added to the sidebar of the model you are creating content for.
Check that locales other than the default one have been added and are currently shown for the content entry you're working on. You can find information on how to add, show or hide translations here.