Sending Word files for translation

To translate Word, OpenOffice ODT, RTF or TXT file, send a POST request to the https://api.groupdocs.cloud/v2.0/translation/document GroupDocs.Translation Cloud REST API endpoint. To authorize the request, pass the access token in Authorization header (Bearer authentication).

The file and translation parameters are provided in JSON format in the request body.

{
  "sourceLanguage": "string",
  "targetLanguages": [
    "string"
  ],
  "file": "string",
  "url": "string",
  "savingMode": "Files",
  "format": "Unknown",
  "outputFormat": "string",
  "pages": [
    0
  ]
}
Note
Though you have a possibility to provide your file via cURL, please firstly upload it and pass its URL.

Evaluation mode

To use GroupDocs.Translation Cloud REST API in evaluation mode, send a POST request to the endpoint https://api.groupdocs.cloud/v2.0/translation/document/trial.

This endpoint does not use the Authorization header, so there is no need to generate an access token. All other parameters remain the same as in regular file translation requests.

Translation settings

PropertyTypeDefault valueDescription
sourceLanguageStringen (English)Language code of the source file.
targetLanguagesList of stringsn/aLanguage codes into which the file should be translated.
urlStringn/aLink to a file obtained while uploading it.
formatStringUnknownFormat of the original document.
outputFormatStringn/aExtension of translated file, if it should be converted.
pagesList of integersnullList of 1 based indexes of pages in PDF document.
savingModeStringFilesIf the translated file should be saved as file (Files), archive (Archive) or both (Both).

Return value

If successful, this method returns JSON with a unique identifier (value of the id property) of the translation request in the queue:

{
	"status": 202,
	"message": "Starting translation",
	"id": "a4fc6c6e-81b0-43c8-b62b-b8bb99520ce9"
}

Otherwise, it returns a HTTP status code corresponding to the error.

What’s next

Translation will take a few seconds, depending on the size of the file, the volume of its textual content and the current GroupDocs.Translation Cloud load. See the article Fetching translations for information on how to get translations from the server.

cURL example

curl --location --request POST 'https://api.groupdocs.cloud/v2.0/translation/document' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...UV1hLfgNCSQ4VKGCOA' \
--data '{
  "sourceLanguage": "en",
  "targetLanguages": [
    "de"
  ],
  "url": "https://translation-groupdocs-app.s3.us-west-2.amazonaws.com/0cd7b09d-4d63-4bcd-a9a5-dfd72897aa17.pdf...ff474526313a24821e98",
  "savingMode": "Files",
  "outputFormat": "pdf",
  "format": "Docx",
  "pages": null
}'
curl --location --request POST 'https://api.groupdocs.cloud/v2.0/translation/document/trial' \
--header 'Content-Type: application/json' \
--data '{
  "sourceLanguage": "en",
  "targetLanguages": [
    "de"
  ],
  "url": "https://translation-groupdocs-app.s3.us-west-2.amazonaws.com/0cd7b09d-4d63-4bcd-a9a5-dfd72897aa17.pdf...ff474526313a24821e98",
  "savingMode": "Files",
  "outputFormat": "pdf",
  "format": "Docx",
  "pages": null
}'
{
	"status": 202,
	"message": "Starting translation",
	"id": "a4fc6c6e-81b0-43c8-b62b-b8bb99520ce9"
}