Download files (Async)

post https://api.lokalise.com/api2/projects/{project_id}/files/async-download

Starts a project export process. The progress of the process can be tracked using the list all processes API endpoint. Once complete, the download URL can be accessed using the Retrieve process API endpoint. For general details about the Download endpoint, please refer to the Download files API endpoint.

Path Params

project_id

string

required

A unique project identifier

Body Params

format

string

required

File format (e.g. json, strings, xml). Must be file extension of any of the file formats we support. May also be ios_sdk or android_sdk for respective OTA SDK bundles.

original_filenames

boolean

Enable to use original filenames/formats. If set to false all keys will be export to a single file per language.

bundle_structure

string

Bundle structure, used when original_filenames set to false. Allowed placeholders are %LANG_ISO%, %LANG_NAME%, %FORMAT% and %PROJECT_NAME%).

directory_prefix

string

Directory prefix in the bundle, used when original_filenames set to true). Allowed placeholder is %LANG_ISO%.

all_platforms

boolean

Enable to include all platform keys. If disabled, only the keys, associated with the platform of the format will be exported.

filter_langs

array of strings

List of languages to export. Omit this parameter for all languages.

filter_langs

filter_data

array of strings

Narrow export data range. Allowed values are translated or untranslated, reviewed (or reviewed_only), last_reviewed_only, verified and nonhidden.

filter_data

filter_filenames

array of strings

Only keys attributed to selected files will be included. Leave empty for all.

filter_filenames

add_newline_eof

boolean

Enable to add new line at end of file (if supported by format).

custom_translation_status_ids

array of strings

Only translations attributed to selected custom statuses will be included. Leave empty for all.

custom_translation_status_ids

include_tags

array of strings

Narrow export range to tags specified.

include_tags

exclude_tags

array of strings

Specify to exclude keys with these tags.

exclude_tags

export_sort

string

Export key sort mode. Allowed value are first_added, last_added, last_updated, a_z, z_a.

export_empty_as

string

Select how you would like empty translations to be exported. Allowed values are empty to keep empty, base to replace with the base language value, null to replace with null (YAML export only), or skip to omit.

export_null_as

string

(Ruby on Rails YAML export only) Select how you would like null (void) translations to be exported. Allowed values are null to keep null, empty to replace with empty string.

include_comments

boolean

Enable to include key comments and description in exported file (if supported by the format).

include_description

boolean

Enable to include key description in exported file (if supported by the format).

include_pids

array of strings

Other projects ID's, which keys should be included with this export.

include_pids

triggers

array of strings

Trigger integration exports (must be enabled in project settings). Allowed values are amazons3, gcs, github, github-enterprise, gitlab, bitbucket, bitbucket-enterprise, azure.

triggers

filter_repositories

array of strings

Pull requests will be created only for listed repositories (organization/repository format). Leave empty array to process all configured integrations by platform only.

filter_repositories

replace_breaks

boolean

Enable to replace line breaks in exported translations with \n.

disable_references

boolean

Enable to skip automatic replace of key reference placeholders (e.g. [%key:hello_world%]) with their corresponding translations.

plural_format

string

Override the default plural format for the file type. Allowed values are json_string, icu, array, generic, symfony, i18next, i18next_v4. See Plurals and placeholders for more information about plural support for specific file formats.

placeholder_format

string

Override the default placeholder format for the file type. Allowed values are printf, ios, icu, net, symfony, i18n, raw). See Plurals and placeholders for more information.

webhook_url

string

Once the export is complete, sends a HTTP POST with the generated bundle URL to the specified URL.

language_mapping

array of objects

List of languages to override default iso codes for this export.

language_mapping

icu_numeric

boolean

If enabled, plural forms zero, one and two will be replaced with =0, =1 and =2 respectively. Only works for ICU plural format.

escape_percent

boolean

Only works for printf placeholder format. When enabled, all universal percent placeholders "[%]" will be always exported as "%%".

indentation

string

Provide to override default indentation in supported files. Allowed values are default, 1sp, 2sp, 3sp, 4sp, 5sp, 6sp, 7sp, 8sp and tab.

yaml_include_root

boolean

(YAML export only). Enable to include language ISO code as root key.

json_unescaped_slashes

boolean

(JSON export only). Enable to leave forward slashes unescaped.

java_properties_encoding

string

(Java Properties export only). Encoding for .properties files. Allowed values are utf-8 and latin-1.

java_properties_separator

string

(Java Properties export only). Separator for keys/values in .properties files. Allowed values are = and :.

bundle_description

string

Description of the created bundle. Applies to ios_sdk or android_sdk OTA SDK bundles.

filter_task_id

number

Only keys attributed to the task will be included. Available only for offline_xliff file format.

compact

boolean

(ARB export only). Export the minimum required structure for use in production. Don't include metadata such as context, comments and screenshots.

Response

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.lokalise.com/api2/projects/project_id/files/async-download \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK