Page History

/editor/instanttranslateapi/filepretranslate

Step 1: Starts a task-import with the file and its pretranslation.

As long as the import is running, the response in step 2 for this file will say "isImporting" instead of returning the download-link. You might need to repeat step 2 until you get the link.

The translated files are available until their configured lifetime is over; then they will be removed automatically.

Response (example): {"taskId":"539"}

targetWithResources format:         

When requesting this api endpoint, for the given language combination and for all clients of a user with InstantTranslate right, a separate OpenTM2 memory will be created (if it does not exist already) and the requested content will be saved there.

To enable InstantTranslate memory to be created for the client, this config must be set to something else then the default value, which is "disabled": runtimeOptions.InstantTranslate.saveToServices

This system config can be overridden client specific in the clients overview. By default this feature is disabled.

                          
  [                                                                                                                                                                                                                                                           
    {"language": "de", "resources": [123]},
  ]

Each entry has:                                                                                                                                                                                                                                             
  - language (string, required): rfc5646 target language code                                                                                                                                                                                                 
  - resources (array of int, optional): specific language resource IDs to use for that target. Empty array = use all available.

NOTE: for multiple target translations use filepretranslateproject endpoint.

/editor/instanttranslateapi/filepretranslateproject

/editor/instanttranslateapi/task/{taskId}/sendtohumanrevision

/editor/instanttranslateapi/task/{taskId}/edittask

/editor/instanttranslateapi/task/{taskId}/savetotm

The request parameters must be encapsulated in data parameter as json.

ex:

data={"sourceLanguage": "en","targetLanguage": "de","source": "Simple text","target": "Einfacher Text"}

An example call via CURL could look like this:

curl --location --request POST 

'http://t5docker.localdev/editor/instanttranslateapi/writetm' \
--header 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' \
--header 'Accept: application/json' \
--header 'Translate5AuthToken: {{token}}' \
--form 'data="{\"sourceLanguage\": \"en\",\"targetLanguage\": \"de\",

\"source\": \"Simple text hello\",\"target\": \"Einfacher Text hallo\"}"' 

Auto creation of memory

For each customer and language and language combination provided in the request(see example on the left), one memory will be auto created. And the source and the target content will be saved in those memories. 

Which customers will be used? The assigned customers to all users, not the current user which is making the request, but all available users in translate5 with instantTranslate role.

With the runtimeOptions.InstantTranslate.saveToServices (overwrite on client level) it can be defined which TM memory resources can be used. By default this is disabled on instance level. Currently only available options are t5memory.

/editor/instanttranslateapi/filepretranslatenow

(since 7.15.0)

Starts a task-import with the file and its pretranslation.

Waits until the import is finished and directly returns the results of the translated task.

The translated files are available until their configured lifetime is over; then they will be removed automatically.

Response examples: {"taskId":"539","fileTranslation":".."}
{"taskId":"539","error":"Task import timeout exceeded (60s)"}

targetWithResources format:                                                                                                                                                                                                                                 
  [                                                                                                                                                                                                                                                           
    {"language": "de", "resources": [123]},
  ]

Each entry has:                                                                                                                                                                                                                                             
  - language (string, required): rfc5646 target language code                                                                                                                                                                                                 
  - resources (array of int, optional): specific language resource IDs to use for that target. Empty array = use all available.