Sign in

v1

latestOpenAPI 3.0.32026-07-2415128381.3 KB
Files

Download files

Exports project files as a .zip bundle. Generated bundle will be uploaded to an Amazon S3 bucket, which will be stored there for 1 month available to download. As the bundle is generated and uploaded you would get a response with the URL to the file. Requires Download files admin right.

There are two ways to group keys by filenames when you are exporting - either all keys to a single file per language or use the previously assigned filenames. <a href="https://developers.lokalise.com/docs/webhooks-guide" target="`_new`">Learn more</a>.

Requires <code>read_files</code> OAuth access scope.

Please note: Starting June 1st, 2025, this endpoint will be limited to projects with under 10,000 key-language pairs, for more details <a href="https://developers.lokalise.com/reference/file-download-limitations" target="`_new`">See our API limits page</a>

post/projects/{project_id}/files/download

Path parameters

project_idstring required

A unique project identifier

Request body

formatstring required

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

original_filenamesboolean

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

bundle_structurestring

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

directory_prefixstring

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

all_platformsboolean

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

filter_langsstring[]

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

filter_datastring[]

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

filter_filenamesstring[]

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

add_newline_eofboolean

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

custom_translation_status_idsstring[]

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

include_tagsstring[]

Narrow export range to tags specified.

exclude_tagsstring[]

Specify to exclude keys with these tags.

export_sortstring

Export key sort mode. Allowed value are <code>first_added</code>, <code>last_added</code>, <code>last_updated</code>, <code>a_z</code>, <code>z_a</code>.

export_empty_as'base' | 'empty' | 'null' | 'skip'

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

export_null_as'empty' | 'null'

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

include_commentsboolean

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

include_descriptionboolean

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

include_pidsstring[]

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

triggersstring[]

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

filter_repositoriesstring[]

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

replace_breaksboolean

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

disable_referencesboolean

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

plural_format'array' | 'generic' | 'i18next' | 'i18next_v4' | 'icu' | 'json_string' | 'symfony'

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

placeholder_format'icu' | 'ios' | 'net' | 'printf' | 'symfony' | 'i18n' | 'raw'

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

webhook_urlstring

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

icu_numericboolean

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

escape_percentboolean

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

indentation'1sp' | '2sp' | '3sp' | '4sp' | '5sp' | '6sp' | '7sp' | '8sp' | 'default' | 'tab'

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

yaml_include_rootboolean

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

json_unescaped_slashesboolean

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

java_properties_encodingstring

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

java_properties_separatorstring

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

bundle_descriptionstring

Description of the created bundle. Applies to <code>ios_sdk</code> or <code>android_sdk</code> OTA SDK bundles.

filter_task_idnumber

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

compactboolean

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

Response

OK

project_idstring
bundle_urlstring