Lokalise Vantage API: Introduction

Lokalise Vantage is a workspace for translating long-form and creative content such as documentation, articles, presentations, marketing materials, and content imported from external systems.

The Vantage API provides programmatic access to data stored in Lokalise Vantage projects.

For more information about the product itself, see the Lokalise Vantage documentation.

Vantage projects

A Vantage project groups the content you want to translate together with its base language, target languages, and translation workflow.

Unlike Lokalise Expert projects, Vantage projects are designed around content rather than translation keys. Content can come from supported document formats or integrations such as Contentful and Google Docs. Vantage parses this content, splits it into segments, translates it, and optionally sends translations for human review.

Some important Vantage project properties to keep in mind when building an integration:

• A project has one base language. The base language cannot be changed after the project is created.
• New target languages can be added later.
• Content is segmented automatically by Vantage.
• Source content cannot be edited directly in the Vantage editor. It must be updated in the original file or content source and imported again.
• Vantage projects share team subscription quotas such as processed words and AI translation usage with the rest of the Lokalise team.
• Vantage uses a single project model rather than the multiple project types available in Lokalise Expert.

For uploaded files, Vantage currently supports DOCX, PPTX, HTML, Markdown, XLSX, and IDML files up to 50 MB each.

Vantage API resource model

Vantage does not use the key → translation model familiar from the Lokalise Expert API. Its content is exposed through the following hierarchy:

Project
└── Item
    └── Content unit
        └── Segment
            └── Quality issue

• Project — the Vantage project containing the localized content.
• Item — a top-level content object within the project, such as content imported from a file or external source.
• Content unit — a structured unit of content belonging to an item.
• Segment — segmented content associated with a content unit and language.
• Quality issue — a quality problem detected for a segment or content unit.

The API provides endpoints for traversing these resources, for example by listing project items, retrieving the content units of an item, and then retrieving segments for a content unit.

IDs and pagination

Resources in the Vantage API use UUIDs. For example, the projectId, itemId, and contentUnitId path parameters expected by the current endpoints are UUID values.

List endpoints use cursor-based pagination. When a response contains a cursor in meta.cursor, pass it as the after parameter to retrieve the next page.

Do not assume that pagination, identifiers, resources, or request parameters work the same way as in the Lokalise Expert REST API v2. When working with Vantage, follow the conventions documented for the /vantage/v1 endpoints.