Sign in

v2

latestOpenAPI 3.0.02026-08-07103189636.5 KB
Files

Download translated file (single locale or multi-locale)

Downloads the requested translated file from Smartling.

This endpoint supports two modes depending on the value of localeIds:

Single-locale mode

  • Provide a single locale ID, e.g. fr-FR
  • Smartling returns a file containing translations only for that locale
  • Supported for all file types.

Multi-locale mode

  • Provide a comma-separated list of locale IDs, e.g. fr-FR,de-DE,es-ES
  • Or specify all to include all available locales
  • Smartling returns a combined multi-locale file with translations for all specified locales inside one file
  • Supported only for: MADCAP, DITA_ZIP, CSV, XLSX_TEMPLATE, XCSTRINGS

It is important to check the HTTP response status code. If Smartling finds and returns the file normally, you will receive a 200 SUCCESS response. If you receive any other response status code other than 200, the requested file will not be part of the response.

When you upload a UTF-16 character encoded file, then /file/get requests for that file will have a character encoding of UTF-16. All other uploaded files will be returned with a character encoding of UTF-8.

You can always use the content-type header in the response of a file/get request to determine the character encoding.

Note: The filename in the response header is based on the fileUri associated with the requested file. In most cases, the filename is exactly the fileUri provided. The only exception to this is with .pot gettext files. When a .pot file is specified as the fileUri, Smartling returns a .po file.

get/files-api/v2/projects/{projectId}/locales/{localeIds}/file

Path parameters

projectIdstring required

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

localeIdsstring required

One of:

  • A single locale ID, e.g. fr-FR → single-locale mode
  • A comma-separated list of locale IDs, e.g. fr-FR,de-DE → multi-locale mode
  • all → download translations for all available locales

Query parameters

fileUristring required

Value that uniquely identifies the downloaded file

retrievalType'pending' | 'published' | 'pseudo' | 'contextMatchingInstrumented'

Determines the desired format for the download. Applies to translated files only.

retrievalTypeDescription
pendingSmartling returns any translations (including non-published translations)
publishedSmartling returns only published/pre-published translations.
pseudoSmartling returns a modified version of the original text with certain characters transformed and the text expanded. For example, the uploaded string "This is a sample string", will return as "Thís ís á sámplé str~íñg". Pseudo translations enable you to test how a longer string integrates into your application.
contextMatchingInstrumentedSmartling returns a modified version of the original file with strings wrapped in a specific set of Unicode symbols that can later be recognized and matched by the Chrome Context Capture Extension.
includeOriginalStringsboolean

Specifies whether Smartling will return the original string or an empty string where no translation is available. This parameter is only supported for ANDROID, ARB, GETTEXT, IDML, IOS, JAVA Properties, JSON, QT, STRINGSDICT, XLIFF, XML, and YAML files. If unset, the default is <code>true</code>.

ValueDescription
trueIf there is no translation, Smartling returns the original string.
falseIf there is no translation, Smartling returns an empty string.

Response

OK