Help center

    Start for free    Sign in search

      Get Started Add Content Billing FAQs

      Automation action: DeepL API

      Quang Pham

      Updated on November 14th, 2024

      Table of Contents

      The DeepL API automation action enhances your localization workflow by integrating DeepL’s powerful translation engine into Gridly. In addition to leveraging context and glossaries, the DeepL engine handles XML and HTML tags and structures effectively. This action allows you to automate translations, ensuring fast, accurate, and context-aware results directly within your Grids.

      Prerequisite

      • DeepL automation action is only available for Professional and Enterprise plans. 
      • To use the DeepL integration in Gridly, you need a DeepL API account and API key.
      • If you are not familiar with creating Gridly Automations, refer to this article: Creating an Automation.
       

      Install DeepL API automation action

      1.  Click in the header to open the Integrations window.
      2. Open the Automation Action tab.
      3. Find DeepL API in the list and click Subscribe > Confirm.
      4. Click Install.

       

      Connect your DeepL API account

      1. In Gridly project dashboard, click .
      2. Select Integration settings > DeepL API to access DeepL API key management page.
      3. Input your DeepL API key then click Save.

       

      Configure DeepL API automation action

      After creating an automation and select your trigger, click Add Step. Select DeepL API in the automation action list.

       You can configure these settings for the DeepL API action:

      • Select trigger value to translate: Choose the column(s) you want DeepL to translate.
      • Select original text language
        • Auto Detect Language: Let DeepL detect the source language by itself.
        • Choose your source language.
      • Select language to translate to: Choose a target language.
      • Select Output column to hold the result: Choose a column in your Grid to hold the translation.
      • Context: Provide a specific context to enhance translation quality.

      To access more advanced options supported by DeepL API, click Custom Options.

      • Split sentence: Set whether the translation engine should split input into sentences.
        • All: Splits on punctuation and on newlines.
        • Off: No splitting at all, whole input is treated as one sentence.
        • No newline: Splits on punctuation only, ignoring newlines.
      • Preserve formatting: If selected, the DeepL engine will try to match the formatting of the translation as closely as possible to the original text's.
      • Formality: Sets whether the translated text should lean towards formal or informal language. 
        • Default
        • More: For a more formal translation.
        • Less: For a more informal translation.
        • Prefer more: For a more formal translation if possible, otherwise go back to default formality.
        • Prefer less: For a more informal translation if possible, otherwise go back to default formality.
      • Glossary ID: Enter the ID of the DeepL Glossary you want to use for translation.
      • Tag handling: Set which kind of tags to handle.
        • XML
        • HTML
      • Outline detection: If selected, the DeepL engine will recognize and preserve the XML structure in the translation.
      • Non-splitting tags: Enter a list of HTML and XML tags (separated by commas). These tags will never cause splits in translations. 
      • Splitting tags: Enter a list of HTML and XML tags (separated by commas). These tags will always cause split in the translation. Texts between these tags are translated separately.
      • Ignore tag: Enter a list of HTML and XML tags (separated by commas). Texts between these tags will not be translated. 

      Test the DeepL API automation action

      1. Switch the toggle next to the Automation's name to activate it.
      2. Click Test Automation.

      Was this article helpful?


      3 out of 3 found this helpful

      Still need some help?

      Contact Support