Sign in

v1

latestOpenAPI 3.0.12026-08-064517.0 KB
Download API

Download translations for a language in a specified file format

<b>Note:</b> This endpoint is intended for getting translation files to your source-code. This endpoint should not be called directly from you app in runtime, as it has <b>rate-limiting</b>. <br/>For over-the-air translation updates please consider using our <a href="https://localizely.com/flutter-over-the-air/" target="_blank">SDK for Flutter</a> or <a href="https://localizely.com/aws-s3-integration/" target="_blank">integrate with AWS S3 bucket</a>.

get/v1/projects/{project_id}/files/download

Path parameters

project_idstring required

Project ID - Can be found on 'My projects' page

Query parameters

branchstring

Name of the branch to download file from. Only in case of activated branching feature.

lang_codesstring

Language to download, specified as language code. e.g. en, en_GB or en-GB. For multiple languages use comma separator. If omitted, all languages are downloaded.

type'android_xml' | 'ios_strings' | 'ios_stringsdict' | 'java_properties' | 'rails_yaml' | 'angular_xlf' | 'flutter_arb' | 'dotnet_resx' | 'po' | 'pot' | 'json' | 'csv' | 'xlsx' required

File format

java_properties_encoding'utf_8' | 'latin_1'

(Only for Java .properties files download) Character encoding. Default is latin_1.

include_tagsstring[]

Optional list of tags to be downloaded. <br>If not set, all string keys will be considered for download. <br><br>Multiple tags can be defined in a following way: &include_tags=ANDROID&include_tags=ANDROID_SPRINT05.

exclude_tagsstring[]

Optional list of tags to be excluded from download. <br>If not set, all string keys will be considered for download. <br><br> Multiple tags can be defined in a following way: &exclude_tags=REMOVED&exclude_tags=REMOVED_SPRINT05.

export_empty_as'empty' | 'main' | 'skip'

Optional. How you would like empty translations to be exported. Allowed values are empty to keep empty, main to replace with the main language value, or skip to omit.

Response

OK, file returned