Documentation

Set up the Magento module in about ten minutes, then use the API reference if you build your own integration.

Requirements

Magento Open Source or Adobe Commerce 2.4, PHP 8.2 or later.
The Scandiweb AI Translator module for Magento (BrassDev_Translator, with the BrassDev_Core module it needs — both are in the download).
A Scandiweb AI Translator account. Your account manager creates it and sends your first API key; you can create more keys in the dashboard.
Outbound HTTPS from your Magento server to https://translator.brass.id.lv.

Install the module

Download from your dashboard

Sign in to the dashboard and open Setup guide. The download always holds the latest release and includes the BrassDev_Core module it needs. Unzip it at the Magento root, so the modules sit here:

app/code/BrassDev/Core
app/code/BrassDev/Translator

Then, from the Magento root:

bin/magento module:enable BrassDev_Core BrassDev_Translator
bin/magento setup:upgrade
bin/magento setup:di:compile   # production mode only
bin/magento cache:flush

To upgrade later, download the new version, replace both folders and run the same commands.

Connect your store

In the Magento admin, go to Stores → Configuration → BrassDev → Auto Translator → Service Connection and fill in:

Field	Value
Service URL	`https://translator.brass.id.lv`
API key	Your key, starting with `sat_live_`. It’s shown once when created; if you lose it, create a new one and revoke the old one.

Save the configuration, then click Test connection. It confirms the service can be reached and the key is accepted for this store.

Keys are bound to your store’s domain

Each key works only for the domain it was created for: the host of your Magento base URL, such as shop.example.com. Wildcards like *.example.com cover subdomains. Staging or a second storefront domain needs its own key or a wildcard; all keys draw on the same monthly credits. A key can also be limited to specific server IP addresses.

Translate content

Open a CMS page, block, product or category and expand the Translator section. Choose the source language, the target store views and the fields, then:

Translate Now translates and saves immediately.
Schedule Translation adds it to the queue that the module’s cron processes.
Pre-Translate stages the result under BrassDev → Translator → Pre-Translations for review, editing and applying per store view.
Estimate shows the expected credits before you spend any.

To translate everything of one type, such as all products for a new store view, use BrassDev → Translator → Bulk Translate. To keep new products and categories translated automatically, enable the automatic translation crons in the module configuration; they fill in missing translations only and never overwrite existing ones.

Troubleshooting

invalid_api_key: The key is missing, mistyped, revoked or expired. Paste it again or create a new key in the dashboard.
domain_not_allowed: The store’s base URL host doesn’t match the key’s domain. Edit the key’s domain in the dashboard, or create a key for this domain.
credits_exhausted: This month’s allowance is used up, including the extra credits your spending limit allows. Raise the limit in the dashboard under Billing → Spending limit, or translation resumes on the 1st.
rate_limited: Too many requests at once. The module waits and retries; lower the queue batch size if it keeps happening.

API reference

Version 1 of the API the Magento module uses. Use it to translate content from your own tooling. JSON in, JSON out.

The API reference is temporarily unavailable.

Magento module guide