Back to Top

Guide for Akeneo OpenAI Content Translator

Updated 6 May 2024

Akeneo OpenAI Translator seamlessly translates text and text area type attribute data between locales, making content translation more efficient.

This tool ensures correct translations and changes in content in the chosen channel, simplifying the management of multilingual product information within the Akeneo PIM.

Akeneo Icecat Connector helps import Icecat catalog content from Icecat to the Akeneo PIM.

Basic Requirements:

  • This module works with Akeneo 7.0.x. Download Akeneo from here
  • Node and Yarn packages need to be installed.
  • This module is compatible with the Akeneo community and Enterprise (Flexibility) editions.
  • If you want to use this extension on Akeneo EE Serenity mode, please contact us.
  • For the Akeneo installation, your Akeneo server should meet these system requirements.


  • Translate localised attributes from one locale to multiple locales automatically.
  • Change the localizable text and text area type attributes for the product and product module.
  • After saving a product, the data will be automatically translated from the base locale to the mapped locale.
  • After bulk editing an attribute, the data should be automatically translated from the base locale to the mapped locale.
  • Select products from the product grid to translate them all at once.


Two different types of module installation processes are available for the module.

  1. Composer Installation
  2. Manual Installation

Installation using Composer

Read This Blog

Searching for an experienced
Akeneo Company ?
Find out More

Before beginning the composer installation

1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository as well as the installation script.

For Akeneo and 7.x

  "scripts": {
        "post-update-cmd": [
           "vendor/webkul/openaitranslator/src/Webkul/OpenAITranslatorBundle/install/ COMPOSER=true NO_DOCKER=true"
        "post-install-cmd": [
           "vendor/webkul/openaitranslator/src/Webkul/OpenAITranslatorBundle/install/ COMPOSER=true NO_DOCKER=true"
        "post-create-project-cmd": [
          "vendor/webkul/openaitranslator/src/Webkul/OpenAITranslatorBundle/install/ COMPOSER=true NO_DOCKER=true"
  "repositories": [{
    "type": "composer",
    "url": ""

3: Use composer to install the extension.

        composer require webkul/openaitranslator

4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.

Manual Installation for Version 7.x

  • After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
  • From the PIM directory, run the following command over the NO-DOCKER instance:.
./src/Webkul/OpenAITranslatorBundle/install/ COMPOSER=false NO_DOCKER=true
  • After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/OpenAITranslatorBundle/install/ COMPOSER=false NO_DOCKER=false

Uninstall Module: For Akeneo 7.x

  • From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/OpenAITranslatorBundle/uninstall/ COMPOSER=false NO_DOCKER=true
  • Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/OpenAITranslatorBundle/uninstall/ COMPOSER=false NO_DOCKER=false

How to Get API Credentials

The user has to first create an OpenAI account and log in to the OpenAI dashboard, as shown in the screenshot.

Akeneo-Get API Credentials-2

A popup will show after the user clicks on the API keys tab. The user will select View API Keys.

Akeneo-Get API Credentials-3

Following that, a page will open with a button labeled Create New Secret Key.

After that, enter the name and click on restricted Allow permission of Models “Read” and Model Capabilities “Write” as shown in the screenshot.

Akeneo-Get API Credentials-4

After that, when the user clicks on the create secret key button, a pop-up box with the API key will appear. The copy button allows the user to copy the key from here.

Akeneo-Get API Credentials-5

Akeneo OpenAI Content Translator – Workflow

After successfully installing the Akeneo OpenAI Content Translator, the AI Translator icon will appear on the left side of the dashboard, as seen below:

 Akeneo OpenAI Content Translator-1

After that, to add a credential, the user will navigate to AI Translator >> Credentials >> Add Credential.

Akeneo OpenAI Content Translator-2

Then, enter your Open AI account’s name and API key.

Akeneo OpenAI Content Translator-3

The user will now click the Save button to save all of their credentials.

Note: If you added several credentials, only one should be enabled and the rest should be disabled.

Akeneo OpenAI Content Translator-4

Then, click Auto translation.Enable the option Enable Auto-Translation, and after that, choose the following details:

  • Source Channel: The chosen channel specifies the source of attribute data retrieval. Attribute values correspond to the selected channel.
  • Target Channel: After saving the product, the attribute’s auto-translated value will be saved in the selected channels.
  • Source Locale: The source of attribute data retrieval is determined by the locale selected. Attribute values relate to the chosen locale.
  • Attributes used to make translation: In this, you can select only localized text and text area attributes.

Note: You can select all the localized text and text area attributes at a time by clicking on select all, and deselect by clicking on deselect.

Akeneo OpenAI Content Translator-5

After that, click the Save button.

Automatic Content Translation

When the user clicks the save button when creating a new product or modifying an existing one, the value is automatically translated from the base to the selected channel locale and selected attributes.

As shown in below image, new data has been added in English After that, click on Save button.

Akeneo OpenAI Content Translator-6

Note: Once you click on save button and then navigate to Activity>>Process Tracker, click on the job to check the execution detail

Akeneo OpenAI Content Translator-7

Once the job is completed, the value will be updated in all selected locales.

Akeneo OpenAI Content Translator-8

Then go back to the product, refresh the page, and select the local data, like German data, which will be automatically updated in the German language.

Akeneo OpenAI Content Translator-9

After that, select French, which will automatically update the description in the French language.

Akeneo OpenAI Content Translator-10

Bulk Action OpenAI Content Translator

To translate the localized attribute from one locale to multiple locales, you have to go to product and select the products.

In this way, you can select multiple products at a time.

Akeneo OpenAI Content Translator-11

After that, click on Bulk Action to translate the action. After that, it will redirect you to a new page where you must complete three steps:

1- Select your action:
In this step, you must choose an action for the bulk action OpenAI Translation. Following that, click the next button.

Akeneo OpenAI Content Translator-12

2 – Change Translation

To change the translation, you have to fill in the details, like:

  • Select from source locale and source channel: In this, you have to select the locale and channel from which you want to change the translation.
  • Target locale and channel: In this, you have to select the locale and channel in which you want to change the translation. You can select multiple locales in this.
  • Select Target Attributes: In this, you can select the text and text area type attributes that you want to update in the product.
Akeneo OpenAI Content Translator-13

After that, click the Next button.

3- Confirm

In this, you have to click Confirm to confirm the process of translation.

Akeneo OpenAI Content Translator-14

After clicking to confirm, you will receive a notification.

Akeneo OpenAI Content Translator-15

After that, go to the process tracker and check the execution details.

Akeneo OpenAI Content Translator-16

Now check the product details in a different locale.


Akeneo OpenAI Content Translator-17


Akeneo OpenAI Content Translator-18


Akeneo OpenAI Content Translator-19


Thank you for reading this documentation. For any queries or doubts, reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.

Please explore our Akeneo Development Services and Quality Akeneo Extensions.

Current Product Version - 1.0.0

Supported Framework Version - 7.x.x

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*

Be the first to comment.

Back to Top

Message Sent!

If you have more details or questions, you can reply to the received confirmation email.

Back to Home

Table of Content