> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/lokalise.md).

# Lokalise

Integration with Lokalise for managing translation projects, keys, languages, and files, and for reacting to import and translation webhooks.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Lokalise  | API Token      |

#### Lokalise

Connect to Lokalise with an API token to manage translation projects, keys, languages, and files.

**Set up in Lokalise**

1. Prepare the Lokalise account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** Create a token from Lokalise > your avatar > Personal profile > API tokens. Read-only tokens can list and read; uploading, downloading, creating keys, adding languages, and managing webhooks also need the token owner to hold the matching project admin right.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Lokalise**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                                                                                             |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Token     | Yes      | Create a token from Lokalise > your avatar > Personal profile > API tokens. Read-only tokens can list and read; uploading, downloading, creating keys, adding languages, and managing webhooks also need the token owner to hold the matching project admin right. [Provider instructions](https://developers.lokalise.com/reference/api-authentication). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Lokalise** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Projects

List the Lokalise projects your API token can access, optionally with translation progress.

**Inputs**

| Field                        | Type    | Required | Description                                                                                         |
| ---------------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------- |
| Project name                 | string  | No       | Only return projects with this exact name. Separate several names with commas.                      |
| Include translation progress | boolean | No       | Also return how complete each project's translations are, overall and per language. Default: false. |
| Max results                  | integer | No       | Maximum number of projects to return. Minimum: 1. Maximum: 100. Default: 25.                        |
| Page                         | integer | No       | Continue from a previous result by entering its next page number. Minimum: 1.                       |

**Outputs**

| Field     | Type          | Description                                                         |
| --------- | ------------- | ------------------------------------------------------------------- |
| Projects  | object\_array | Projects with id, name, base language and optional progress.        |
| Next page | integer       | Page number to request next, empty when there are no more projects. |

#### List Project Languages

List the languages set up in a Lokalise project.

**Inputs**

| Field   | Type            | Required | Description                                                      |
| ------- | --------------- | -------- | ---------------------------------------------------------------- |
| Project | select (string) | Yes      | The Lokalise project. Options load from the selected connection. |

**Outputs**

| Field     | Type          | Description               |
| --------- | ------------- | ------------------------- |
| Languages | object\_array | Languages in the project. |

#### Add Project Language

Add a new language to a Lokalise project so it can be translated.

**Inputs**

| Field    | Type            | Required | Description                                                      |
| -------- | --------------- | -------- | ---------------------------------------------------------------- |
| Project  | select (string) | Yes      | The Lokalise project. Options load from the selected connection. |
| Language | select (string) | Yes      | The language to add. Options load from the selected connection.  |

**Outputs**

| Field           | Type    | Description                                      |
| --------------- | ------- | ------------------------------------------------ |
| Language        | object  | The language in the project.                     |
| Already existed | boolean | Whether the language was already in the project. |

#### Search Keys

Find translation keys in a project by name or tag, with their translations.

**Inputs**

| Field                  | Type            | Required | Description                                                                                                 |
| ---------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------- |
| Project                | select (string) | Yes      | The Lokalise project. Options load from the selected connection.                                            |
| Key names              | string          | No       | Only return these keys. Separate several names with commas.                                                 |
| Tags                   | string          | No       | Only return keys with any of these tags. Separate with commas.                                              |
| Missing translation in | select (string) | No       | Only return keys that are not yet translated into this language. Options load from the selected connection. |
| Show advanced options  | boolean         | No       | Show the result limit, translation toggle, and pagination cursor. Default: false.                           |
| Include translations   | boolean         | No       | Return each key's translation text. Default: true.                                                          |
| Max results            | integer         | No       | Maximum number of keys to return. Minimum: 1. Maximum: 500. Default: 25.                                    |
| Cursor                 | string          | No       | Continue from a previous result.                                                                            |

**Outputs**

| Field       | Type          | Description                                                  |
| ----------- | ------------- | ------------------------------------------------------------ |
| Keys        | object\_array | Matching keys with their translations.                       |
| Next cursor | string        | Cursor for the next page, empty when there are no more keys. |

#### Create Translation Key

Create a new translation key in a project, optionally with its text in one or more languages.

**Inputs**

| Field                 | Type                      | Required | Description                                                                                                                                                                      |
| --------------------- | ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project               | select (string)           | Yes      | The Lokalise project. Options load from the selected connection.                                                                                                                 |
| Key name              | string                    | Yes      | The identifier your app uses for this text.                                                                                                                                      |
| Text in base language | textarea                  | No       | The text in the project's main language.                                                                                                                                         |
| Platforms             | multiple\_select (string) | No       | Which app platforms use this key. Keys are only exported in files for their platforms. Available values: Web, iOS, Android, Other. Default: \["web", "ios", "android", "other"]. |
| Description           | string                    | No       | Context for translators, such as where the text appears.                                                                                                                         |
| Tags                  | string                    | No       | Tags to organise the key. Separate with commas.                                                                                                                                  |
| Show advanced options | boolean                   | No       | Show other-language translations, file name, plural, and character limit. Default: false.                                                                                        |
| Other translations    | textarea                  | No       | Text in other languages, as a JSON object of language code to text.                                                                                                              |
| File name             | string                    | No       | The file this key belongs to when exporting with original file names.                                                                                                            |
| Plural key            | boolean                   | No       | Whether the text changes with a count (1 item, 2 items). Every translation, including the base text, must then be a JSON object of plural forms. Default: false.                 |
| Character limit       | integer                   | No       | Maximum length translators may use.                                                                                                                                              |

**Outputs**

| Field | Type   | Description      |
| ----- | ------ | ---------------- |
| Key   | object | The created key. |

#### Update Translation

Change the translated text of a key in one language.

**Inputs**

| Field                  | Type            | Required | Description                                                                                        |
| ---------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| Project                | select (string) | Yes      | The Lokalise project. Options load from the selected connection.                                   |
| Key                    | string          | Yes      | The key name, or its numeric id.                                                                   |
| Language               | select (string) | Yes      | The language to update. Options load from the selected connection.                                 |
| Translation            | textarea        | Yes      | The new text.                                                                                      |
| Mark as reviewed       | boolean         | No       | Mark the translation as reviewed. Leave unset to keep its current state.                           |
| Mark as needing review | boolean         | No       | Flag the translation as unverified so a reviewer checks it. Leave unset to keep its current state. |

**Outputs**

| Field       | Type   | Description              |
| ----------- | ------ | ------------------------ |
| Translation | object | The updated translation. |

#### Upload Translation File

Import a translation file (JSON, YAML, XLIFF, strings and more) into a project.

**Inputs**

| Field                          | Type            | Required | Description                                                                                                               |
| ------------------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| Project                        | select (string) | Yes      | The Lokalise project. Options load from the selected connection.                                                          |
| Language                       | select (string) | Yes      | The language of the translations in the file. Options load from the selected connection.                                  |
| File name                      | string          | Yes      | Name for the file in Lokalise. Its extension decides the format.                                                          |
| File URL                       | string          | No       | A public link to the file. Use this or File content.                                                                      |
| File content                   | textarea        | No       | The file's text, pasted or produced by a previous step. Use this or File URL.                                             |
| Tags                           | string          | No       | Tags added to the keys in this file. Separate with commas.                                                                |
| Overwrite changed translations | boolean         | No       | Replace translations in Lokalise with the file's text when they differ. Off keeps edits made in Lokalise. Default: false. |
| Show advanced options          | boolean         | No       | Show placeholder conversion, ICU plurals, translation memory, automations, and the wait toggle. Default: false.           |
| Convert placeholders           | boolean         | No       | Convert placeholders such as %s or {name} to Lokalise's universal format. Default: true.                                  |
| Detect ICU plurals             | boolean         | No       | Recognise ICU plural messages in the file. Default: false.                                                                |
| Apply translation memory       | boolean         | No       | Fill in exact matches from translation memory. Default: false.                                                            |
| Run automations                | boolean         | No       | Run the project's automations (for example machine translation) on this upload.                                           |
| Wait for import to finish      | boolean         | No       | Wait until Lokalise finishes importing before continuing. Default: true.                                                  |

**Outputs**

| Field      | Type          | Description                                     |
| ---------- | ------------- | ----------------------------------------------- |
| Process ID | string        | Identifier of the import.                       |
| Status     | string        | Import status.                                  |
| Message    | string        | Details from Lokalise, such as an error reason. |
| Files      | object\_array | Per-file import counts.                         |

#### Download Translation Files

Export a project's translations as a zip of files in the format your app uses.

**Inputs**

| Field                           | Type                      | Required | Description                                                                                                                                                                                                                                                                                                           |
| ------------------------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project                         | select (string)           | Yes      | The Lokalise project. Options load from the selected connection.                                                                                                                                                                                                                                                      |
| File format                     | select (string)           | Yes      | The file format to export, such as JSON for web apps, Strings for iOS or XML for Android. Available values: JSON, YAML, Strings (iOS), Stringsdict (iOS), String Catalog (xcstrings), XML (Android), XLIFF, XLF, Gettext PO, Java Properties, ARB (Flutter), CSV, Excel (xlsx), RESX (.NET), PHP, INI. Default: json. |
| Languages                       | multiple\_select (string) | No       | Languages to include. Leave empty for all. Options load from the selected connection.                                                                                                                                                                                                                                 |
| Include                         | select (string)           | No       | Limit the export to translated, reviewed or verified text. Available values: All text, Translated only, Reviewed only, Verified only, Visible to contributors. Default: all.                                                                                                                                          |
| Tags                            | string                    | No       | Only export keys with any of these tags. Separate with commas.                                                                                                                                                                                                                                                        |
| Keep original file names        | boolean                   | No       | Export keys into the files they were uploaded from. Off puts each language in one file. Default: true.                                                                                                                                                                                                                |
| Show advanced options           | boolean                   | No       | Show file naming, platform scope, empty translations, plural and placeholder syntax, and the wait toggle. Default: false.                                                                                                                                                                                             |
| File naming pattern             | string                    | No       | How files are named when not keeping original names. Default: %LANG\_ISO%.%FORMAT%.                                                                                                                                                                                                                                   |
| Include keys from all platforms | boolean                   | No       | Export keys from every platform, not just the one matching the format. Default: false.                                                                                                                                                                                                                                |
| Empty translations              | select (string)           | No       | What to write for translations that are empty. Available values: Leave empty, Fill with base language text, Skip the key.                                                                                                                                                                                             |
| Plural format                   | select (string)           | No       | Override how plurals are written. Available values: JSON string, ICU, Array, Generic (one/few/many/other), Symfony, i18next, i18next v4.                                                                                                                                                                              |
| Placeholder format              | select (string)           | No       | Override how placeholders are written. Available values: printf (%s, %d), iOS (%@, %1$@), ICU ({name}), .NET ({0}), Symfony (%name%), i18next ({{name}}), Raw (no conversion).                                                                                                                                        |
| Wait for export to finish       | boolean                   | No       | Wait until the zip is ready before continuing. Default: true.                                                                                                                                                                                                                                                         |

**Outputs**

| Field         | Type    | Description                                     |
| ------------- | ------- | ----------------------------------------------- |
| Download URL  | string  | Link to the zip of translation files.           |
| Process ID    | string  | Identifier of the export.                       |
| Status        | string  | Export status.                                  |
| Message       | string  | Details from Lokalise, such as an error reason. |
| Size (KB)     | integer | Size of the zip.                                |
| Keys exported | integer | Number of keys in the export.                   |

#### Get Import or Export Status

Check whether a file upload or download started earlier has finished.

**Inputs**

| Field      | Type            | Required | Description                                                      |
| ---------- | --------------- | -------- | ---------------------------------------------------------------- |
| Project    | select (string) | Yes      | The Lokalise project. Options load from the selected connection. |
| Process ID | string          | Yes      | The process ID returned by an upload or download.                |

**Outputs**

| Field        | Type          | Description                                     |
| ------------ | ------------- | ----------------------------------------------- |
| Process ID   | string        | Identifier of the process.                      |
| Type         | string        | Kind of process.                                |
| Status       | string        | Process status.                                 |
| Message      | string        | Details from Lokalise.                          |
| Download URL | string        | Link to the exported zip, for finished exports. |
| Files        | object\_array | Per-file import counts, for imports.            |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### File Imported

Starts a workflow when a translation file finishes importing into a Lokalise project.

StackAI registers a Lokalise webhook for the selected project automatically when you enable this trigger; there is nothing to paste into Lokalise. IMPORTANT: registering or removing this webhook needs the API token owner to hold the project's "Manage settings" admin right. Lokalise retries a failed delivery for up to 24h, then disables the webhook; re-enable this trigger to re-register it.

**Configuration**

| Field   | Type            | Required | Description                                                               |
| ------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Project | select (string) | Yes      | The Lokalise project to watch. Options load from the selected connection. |

**Event inputs**

| Field         | Type     | Required | Description                                |
| ------------- | -------- | -------- | ------------------------------------------ |
| Project ID    | string   | Yes      | Project id.                                |
| Project name  | string   | Yes      | Project name.                              |
| Branch        | string   | No       | Project branch, if branching is used.      |
| Import ID     | string   | No       | Identifier of this file import.            |
| File name     | string   | Yes      | The imported file.                         |
| Format        | string   | No       | File format.                               |
| Language      | string   | No       | Language of the file.                      |
| Keys inserted | integer  | Yes      | New keys created by the import.            |
| Keys updated  | integer  | Yes      | Existing keys changed by the import.       |
| Keys skipped  | integer  | Yes      | Keys left unchanged.                       |
| Uploaded by   | string   | No       | Email of the person who uploaded the file. |
| Imported at   | datetime | Yes      | When the import happened.                  |

**Outputs**

| Field         | Type     | Description                                |
| ------------- | -------- | ------------------------------------------ |
| Project ID    | string   | Project id.                                |
| Project name  | string   | Project name.                              |
| Branch        | string   | Project branch, if branching is used.      |
| Import ID     | string   | Identifier of this file import.            |
| File name     | string   | The imported file.                         |
| Format        | string   | File format.                               |
| Language      | string   | Language of the file.                      |
| Keys inserted | integer  | New keys created by the import.            |
| Keys updated  | integer  | Existing keys changed by the import.       |
| Keys skipped  | integer  | Keys left unchanged.                       |
| Uploaded by   | string   | Email of the person who uploaded the file. |
| Imported at   | datetime | When the import happened.                  |

#### Translation Updated

Starts a workflow when a translation is edited in a Lokalise project.

StackAI registers a Lokalise webhook for the selected project automatically when you enable this trigger; there is nothing to paste into Lokalise. Pick one or more languages to only fire for those, or leave it empty to fire for every language. IMPORTANT: registering or removing this webhook needs the API token owner to hold the project's "Manage settings" admin right. Lokalise retries a failed delivery for up to 24h, then disables the webhook; re-enable this trigger to re-register it.

**Configuration**

| Field     | Type                      | Required | Description                                                                                    |
| --------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------- |
| Project   | select (string)           | Yes      | The Lokalise project to watch. Options load from the selected connection.                      |
| Languages | multiple\_select (string) | No       | Only fire for these languages. Leave empty for all. Options load from the selected connection. |

**Event inputs**

| Field          | Type     | Required | Description                              |
| -------------- | -------- | -------- | ---------------------------------------- |
| Project ID     | string   | Yes      | Project id.                              |
| Project name   | string   | Yes      | Project name.                            |
| Branch         | string   | No       | Project branch, if branching is used.    |
| Translation ID | integer  | Yes      | Translation id.                          |
| New text       | string   | Yes      | The new translation text.                |
| Previous text  | string   | No       | The text before the change.              |
| Language       | string   | Yes      | Language code.                           |
| Language name  | string   | No       | Language name.                           |
| Key ID         | integer  | Yes      | Key id.                                  |
| Key name       | string   | Yes      | Key name.                                |
| Edited by      | string   | No       | Email of the person who made the change. |
| Updated at     | datetime | Yes      | When the change happened.                |

**Outputs**

| Field          | Type     | Description                              |
| -------------- | -------- | ---------------------------------------- |
| Project ID     | string   | Project id.                              |
| Project name   | string   | Project name.                            |
| Branch         | string   | Project branch, if branching is used.    |
| Translation ID | integer  | Translation id.                          |
| New text       | string   | The new translation text.                |
| Previous text  | string   | The text before the change.              |
| Language       | string   | Language code.                           |
| Language name  | string   | Language name.                           |
| Key ID         | integer  | Key id.                                  |
| Key name       | string   | Key name.                                |
| Edited by      | string   | Email of the person who made the change. |
| Updated at     | datetime | When the change happened.                |

#### Key Added

Starts a workflow when a new translation key is added to a Lokalise project.

StackAI registers a Lokalise webhook for the selected project automatically when you enable this trigger; there is nothing to paste into Lokalise. IMPORTANT: registering or removing this webhook needs the API token owner to hold the project's "Manage settings" admin right. Lokalise retries a failed delivery for up to 24h, then disables the webhook; re-enable this trigger to re-register it.

**Configuration**

| Field   | Type            | Required | Description                                                               |
| ------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Project | select (string) | Yes      | The Lokalise project to watch. Options load from the selected connection. |

**Event inputs**

| Field        | Type     | Required | Description                            |
| ------------ | -------- | -------- | -------------------------------------- |
| Project ID   | string   | Yes      | Project id.                            |
| Project name | string   | Yes      | Project name.                          |
| Branch       | string   | No       | Project branch, if branching is used.  |
| Key ID       | integer  | Yes      | Key id.                                |
| Key name     | string   | Yes      | Key name.                              |
| Base text    | string   | No       | The key's text in the base language.   |
| Tags         | array    | No       | Tags on the key. Default: \[].         |
| Added by     | string   | No       | Email of the person who added the key. |
| Added at     | datetime | Yes      | When the key was added.                |

**Outputs**

| Field        | Type          | Description                            |
| ------------ | ------------- | -------------------------------------- |
| Project ID   | string        | Project id.                            |
| Project name | string        | Project name.                          |
| Branch       | string        | Project branch, if branching is used.  |
| Key ID       | integer       | Key id.                                |
| Key name     | string        | Key name.                              |
| Base text    | string        | The key's text in the base language.   |
| Tags         | string\_array | Tags on the key.                       |
| Added by     | string        | Email of the person who added the key. |
| Added at     | datetime      | When the key was added.                |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/lokalise.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
