⚠️

Beta

This API is still in beta. It is intended specifically for Lokalise Vantage. If you need to work with Lokalise Expert projects, including software localization projects based on keys and translations, use the Lokalise REST API v2 instead.

Vantage endpoints use the /vantage/v1 namespace and have their own resource model and API conventions.

Start an export of the project. The export runs in the background. Poll GET /exports/{exportId} until its status is COMPLETED or FAILED, then get the file with GET /exports/{exportId}/download-url.

Choose what to export with one of these:

• {} (an empty object) exports every item in every language.
• locales or languageIds exports every item in those languages.
• items exports only those items, each in the languages you list for it, or in every language if you list none.

A body with more than one of them is rejected.

Name a language by its locale, such as fr or de-DE, or by its project language id. Do not mix the two in one place. Locales are case-insensitive and accept _ or - as the separator, so pt_BR and pt-BR are the same language. Get a project lists the project languages, with the id in projectLanguageUuid and the locale in languageIso.

You get one file per item and language, in the item’s original format. Each file is named after the item, with the locale before the extension, for example guide.de-DE.docx. If the export has one file, you download that file. If it has several, you download them in one ZIP archive, with no folders.

The export does not wait for translation or review. It uses the current value of each segment, so segments that are not APPROVED yet can contain unreviewed AI translations, and segments whose translation failed contain the source text.