Sending Excel and ODS files for translation

To translate Excel or OpenOffice ODS file, send a POST request to the https://api.groupdocs.cloud/v2.0/translation/spreadsheet 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",
  "worksheets": [
    0
  ],
  "ranges": {
    worksheetIndex: {
      "rows": [
        0
      ],
      "columns": [
        0
      ],
      "ranges": [
        {
          "cellStartIndex": "string",
          "cellEndIndex": "string"
        }
      ]
    }
  }
}

Note
Though you have a possibility to provide your file via cURL, please firstly upload it and pass its URL.

Evaluation mode

Evaluation mode is not available for Excel files, kindly register account and try Excel translation with provided free credits.

Translation settings

Property	Type	Default value	Description
`sourceLanguage`	String	`en` (English)	Language code of the source file.
`targetLanguages`	List of strings	n/a	Language codes into which the file should be translated.
`url`	String	n/a	Link to a file obtained while uploading it.
`format`	String	`format`	Extension of your file, shoud start with capital letter, e.g. Docx.
`outputFormat`	String	n/a	Extension of translated file, if it should be converted.
`worksheets`	List of integers	null	List of 1 based indexes of worksheets in Excel spreadsheet.
`ranges`	Dictionary	nulll	Dictionary of specific ranges in Excel spreadsheet to translate, where the key is the worksheet index and the value is either list of indexes of specific rows or specific columns or tuple of cells indexes.
`savingMode`	String	Files	If 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/spreadsheet' \
--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",
  "format": "Xlsx",
  "outputFormat": "xlsx",
  "worksheets": null,
  "ranges": null
}'

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