The Localazy API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Run this API in Postman

You can fork the API collection into your own workspace or browse its full content here.

Run in Postman

Libraries

Take a look at our npm library for Typescript/Javascript. It wraps the entire API, making things easier for you. 👉 @localazy/api-client

Base url

Localazy API is available at https://api.localazy.com, and all endpoints in this document are relative to this base URL.

https://api.localazy.com

Authentication

Learn how to authenticate with Localazy API

Endpoints reference

Learn what options are available when using Localazy API. Endpoints are grouped by the documentation page that covers them.

List projects 

[GET] /projects

Learn more about Listing projects endpoint

Import content to a project 

[POST] /projects/{projectId}/import

Learn how to import content to Localazy via API

List available file types 

[GET] /import/formats

Learn how to get a list of available file types for importing strings including their parameters.

List files in project 

[GET] /projects/{projectId}/files

Learn how to retrieve a list of all files in the project.

List file content 

[GET] /projects/{projectId}/files/{fileId}/keys/{lang}

Learn how to get all translations in a given language via Localazy API

Delete source key 

[DELETE] /projects/{projectId}/keys/{keyId}

Learn how to delete a given source key via Localazy API

Update source key 

[PUT] /projects/{projectId}/keys/{keyId}

Learn how to change properties of a given source key via Localazy API

Set tags on a key 

[PUT] /projects/{projectId}/keys/{keyId}/tags

Learn how to add and remove tags on a single source key

Set tags on multiple keys 

[PUT] /projects/{projectId}/keys/tags

Learn how to add and remove tags on up to 1000 keys at once

Set priority on a key 

[PUT] /projects/{projectId}/keys/{keyId}/priority

Learn how to set the priority of a single source key

Set priority on multiple keys 

[PUT] /projects/{projectId}/keys/priority

Learn how to set the priority of up to 1000 keys at once

List key links 

[GET] /projects/{projectId}/links

Learn how to list the duplicity links configured in a project

Create key link 

[POST] /projects/{projectId}/links/{keyId}

Learn how to link two source keys so only one needs translating

Delete key link 

[DELETE] /projects/{projectId}/links/{keyId}

Learn how to remove a duplicity link

Get translation suggestions 

[GET] /projects/{projectId}/keys/{keyId}/suggestions/tm
[GET] /projects/{projectId}/keys/{keyId}/suggestions/mt
[POST] /projects/{projectId}/keys/{keyId}/suggestions/ai

Learn how to fetch Translation Memory, Machine Translation and Localazy AI suggestions for a key

Submit a translation 

[POST] /projects/{projectId}/keys/{keyId}/translations/{lang}

Learn how to submit a translation for a single key in one target language

Translate content with Localazy AI 

[POST] /projects/{projectId}/ai

Learn how to translate arbitrary content using Localazy AI

List all glossary items 

[GET] /projects/{projectId}/glossary

Learn how to retreive all glossary items via Localazy API

Get glossary item 

[GET] /projects/{projectId}/glossary/{id}

Learn how to retreive a single glossary item via Localazy API

Delete glossary item 

[DELETE] /projects/{projectId}/glossary/{id}

Learn how to delete a glossary item via Localazy API

Create glossary item 

[POST] /projects/{projectId}/glossary

Learn how to create new glossary items via Localazy API

Update glossary item 

[PUT] /projects/{projectId}/glossary

Learn how to update glossary item via Localazy API

List webhooks configuration 

[GET] /projects/{projectid}/webhooks

Learn how to retreive webhook configuration via Localazy API

Update webhooks configuration 

[POST] /projects/{projectid}/webhooks

Learn how to add new webhook configuration via Localazy API

List screenshots 

[GET] /projects/{projectId}/screenshots

Learn how to list the screenshots in a project

List screenshot tags 

[GET] /projects/{projectId}/screenshots/tags

Learn how to list the screenshot tags in a project

Create a screenshot 

[POST] /projects/{projectId}/screenshots

Learn how to create a new screenshot

Update a screenshot 

[PUT] /projects/{projectId}/screenshots/{screenshotId}

Learn how to update the metadata of an existing screenshot

Delete a screenshot 

[DELETE] /projects/{projectId}/screenshots/{screenshotId}

Learn how to delete a screenshot

List CDN metadata files 

[GET] /projects/{projectId}/cdn

Learn how to get the CDN metadata URLs for a project