| URL | Methods | Parameters | Description |
/editor/instanttranslateapi/filepretranslate | POST |
| Name | Type | Info |
|---|
| source | string | Source language (rfc5646) | | target | string | Target language (rfc5646) | | file | multipart/form-data | The file to translate (or use fileName + fileData as alternative to file). "0" as field name is deprecated and will not be supported in one of the next transalte5 versions. OR (since 7.5.0) | | fileName | string | Alternative: file name as POST string | | fileData | string | Alternative: file content as POST string | | customerId | int | Optional. Override customer. Falls back to user's customer with smallest id. | | targetWithResources | string (JSON) | Optional. JSON array specifying per-target-language resource assignments. |
| 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:
[
{"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 | POST |
| Name | Type | Info |
|---|
| source | string | Source language (rfc5646) | | target | string | Comma-separated list of target languages (rfc5646), e.g. "de,fr,es" | | file | multipart/form-data | The file to translate (or use fileName + fileData as alternative to file). "0" as field name is deprecated and will not be supported in one of the next transalte5 versions. OR (since 7.5.0) | | fileName | string | Alternative: file name as POST string | | fileData | string | Alternative: file content as POST string | | customerId | int | Optional. Override customer. Falls back to user's customer with smallest id. | | targetWithResources | string (JSON) | Optional. JSON array specifying per-target-language resource assignments. |
| Starts a project-based file pretranslation that supports multiple target languages. When multiple targets are given, a project with one task per target language is created.
| Code Block |
|---|
| targetWithResources format:
[
{"language": "de", "resources": [123]},
{"language": "fr", "resources": [456, 789]},
{"language": "es", "resources": []}
]
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.
Response (single target):
{"taskId": 539}
Response (multiple targets — project):
{"taskId": 539, "projectTaskIds": [540, 541, 542]}
Where taskId is the project ID and projectTaskIds are the individual task IDs per target language. |
|
/editor/instanttranslateapi/task/{taskId}/sendtohumanrevision | POST | | Name | Type | Info |
|---|
| taskId | int | URL path param — the task ID | | customerId | int | Optional. Must be one of the user's assigned customers. Falls back to primary. | | description | string | Optional. Description for the human revision task. | | workflow | string | Optional. Workflow to use. | | custom | object | Optional. Additional key-value pairs to set on the task. |
| Sends a pretranslated file task to human revision workflow.
Success response: {"result": "success"} |
/editor/instanttranslateapi/task/{taskId}/edittask | POST | | Name | Type | Info |
|---|
| taskId | int | URL path param - the task ID |
| Opens a file translation task for editing in the translate5 editor. Requires config
runtimeOptions.plugins.InstantTranslate.enableTaskEdit to be enabled. Response: Redirects to editor/taskid/{taskId} |
/editor/instanttranslateapi/task/{taskId}/savetotm | POST | | Name | Type | Info |
|---|
| taskId | int | URL path param - the task ID |
| Saves the edited task segments into the InstantTranslate TM. Success response: {"result": "success"} |
| /editor/instanttranslateapi/filelist | GET |
| Step 2: Get a list of all pretranslations that are currently available for the InstantTranslate-user including their downloadUrl. Response: allPretranslatedFiles for tasks with taskId as key . | Code Block |
|---|
| title | Response layout example |
|---|
| {
"allPretranslatedFiles": {
"2237": {
"taskId":"2237",
"taskName": "Apache short-en-de.html",
"sourceLang": "en",
"targetLang": "de",
"downloadUrl": "/editor/task/export/id/2237?format=filetranslation",
"removeDate": "2021-03-18",
"importProgress": []
}
"2464": {
"taskId":"2464",
"taskName": "Single word-de-en.html",
"sourceLang": "de",
"targetLang": "en",
"downloadUrl": "isImporting",
"removeDate": "2021-04-08",
"importProgress": {
"progress": 2, // import percentage
"workersDone": 1, // total workers done
"workersTotal": 9, // total queued workers
"taskGuid": "{a5945d9f-4007-4063-ac17-41da3003dab1}",
"workerRunning": "editor_Plugins_Okapi_Worker"
}
}
},
"dateAsOf": "2021-04-06 17:36:42"
} |
- downloadUrl: 'isImporting' | 'isErroneous' | 'isNotPretranslated' | url (the url starts a common task-export; the translated file is included in the exported ZIP)
- importProgress: check Task importprogress api
|
| editor/instanttranslateapi/writetm | POST | 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: \
--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 memoryFor 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) | POST |
target: string; the target language to translate to. Must be valid rfc5646 code. file: : string; the source language to translate from. Must be valid rfc5646 code. | string | Source language (rfc5646) | | target | string | Target language (rfc5646) | | file |
| The file to translate (or use fileName + fileData as alternative to file). "0" as field name is deprecated and will not be supported in one of the next transalte5 versions. OR (since 7.5.0) | | fileName | string | Alternative: file name |
| POST string | | fileData | string | Alternative: file content |
| as POST string | | customerId | int | Optional. Override customer. Falls back to user's customer with smallest id. | | targetWithResources | string (JSON) | Optional. JSON array specifying per-target-language resource assignments. |
| 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. |