Localization QA API checks translated JSON and localization strings for common localization QA issues.
The API handles localization QA data including missing keys, extra keys, empty values, untranslated values, placeholder mismatches, missing placeholders, extra placeholders, ICU message syntax, ICU variable consistency, plural message structure, locale-specific QA results, multi-locale comparison, usage status, safety notes, and disclaimer.
The API returns QA issue lists, issue type, message key, source value, target value, locale, missing keys, extra keys, empty values, untranslated values, placeholder issues, ICU issues, comparison results by locale, and warnings.
This API is useful for developers, SaaS builders, localization teams, translation workflow platforms, i18n services, product teams, frontend teams, backend teams, QA teams, agencies building multilingual apps, ecommerce platforms, support platforms, CRM services, HR platforms, fintech services, legaltech platforms, edtech platforms, healthtech platforms, B2B software companies, and internal tooling teams.
The API checks localization JSON, placeholders, ICU syntax, and locale comparison results from submitted request data. It does not hack, brute force, attempt logins, scan private systems, scrape restricted content, change customer data, send emails, create calendar events, approve or reject translations, guarantee translation quality, guarantee legal compliance, replace human translation review, or replace professional localization review.
The API response includes a data_disclaimer field explaining that the QA result is based only on submitted localization JSON, placeholder, ICU message, and locale comparison data and is provided for technical review purposes. Results should be reviewed before use in localization, QA, legal, compliance, operational, or business decisions.
{"ok":true,"score":100,"grade":"A","summary":{"total_keys":2,"issue_count":0,"error_count":0,"warning_count":0,"info_count":0},"issues":[],"warnings":[]}
curl --location --request POST 'https://zylalabs.com/api/12798/localization+qa+api/25151/localization+qa+check' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"source": {
"hello": "Hello {name}",
"cart": "{count, plural, one {# item} other {# items}}"
},
"target": {
"hello": "Bonjour {name}",
"cart": "{count, plural, one {# article} other {# articles}}"
},
"locale": "fr-CH"
}'
{"ok":false,"locales":[{"locale":"fr-CH","ok":false,"summary":{"base_key_count":2,"target_key_count":1,"missing_key_count":1,"extra_key_count":0},"missing_keys":["cart.items"],"extra_keys":[],"issues":[{"severity":"error","locale":"fr-CH","key":"cart.items","source_value":"{count} items","message":"Missing target key.","fix_hint":"Add this key to the target locale."}]},{"locale":"de-CH","ok":true,"summary":{"base_key_count":2,"target_key_count":3,"missing_key_count":0,"extra_key_count":1},"missing_keys":[],"extra_keys":["extra.key"],"issues":[{"severity":"info","locale":"de-CH","key":"extra.key","target_value":"Extra","message":"Extra target key.","fix_hint":"Remove this key if it is not used by the app."}]}],"summary":{"locale_count":2,"total_missing_keys":1,"total_extra_keys":1,"total_issues":2}}
curl --location --request POST 'https://zylalabs.com/api/12798/localization+qa+api/25152/compare+locales' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"base": {
"hello": "Hello",
"cart.items": "{count} items"
},
"targets": {
"fr-CH": {
"hello": "Bonjour"
},
"de-CH": {
"hello": "Hallo",
"cart.items": "{count} Artikel",
"extra.key": "Extra"
}
}
}'
{"ok":false,"source_placeholders":["{count}"],"target_placeholders":[],"missing":["{count}"],"extra":[]}
curl --location --request POST 'https://zylalabs.com/api/12798/localization+qa+api/25179/check+placeholders' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"source_value": "You have {count} items",
"target_value": "Vous avez des articles",
"locale": "fr-CH"
}'
{"ok":true,"source_valid":true,"target_valid":true,"source_variables":["count"],"target_variables":["count"],"missing_variables":[],"extra_variables":[],"errors":[]}
curl --location --request POST 'https://zylalabs.com/api/12798/localization+qa+api/25182/check+icu+messages' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"source_value": "{count, plural, one {# item} other {# items}}",
"target_value": "{count, plural, one {# article} other {# articles}}",
"locale": "fr-CH"
}'
| Header | Description |
|---|---|
Authorization
|
[Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed. |
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
Each endpoint returns structured JSON data for localization QA checks. The Localization QA Check endpoint returns summary counts, issue details, warnings, and status. The Compare Locales endpoint returns per-locale comparisons, missing keys, extra keys, issue details, and totals.
Key fields include "ok" (status), "score" (quality score), "grade" (evaluation grade), "summary" (overview of issues), and "issues" (detailed problems). For instance, "issues" may list missing keys or extra keys with severity levels.
Parameters vary by endpoint but generally include source and target JSON data, locale values, and optional settings for detailed checks. For example, the Check Placeholders endpoint uses source and target strings to compare placeholder consistency.
Response data is organized into a main object containing status indicators, summaries, and issue lists. For example, the Compare Locales endpoint groups results by locale, provides a summary for each locale, and lists specific issues found.
Each endpoint provides localization QA information such as missing keys, extra keys, empty values, untranslated values, placeholder mismatches, ICU message syntax issues, variable consistency checks, locale results, issue details, warnings, and status information.
Data accuracy is maintained through systematic checks for localization issues, including validation of JSON structure and ICU syntax. The API does not guarantee translation quality but identifies potential errors for review.
Typical use cases include validating localization for software applications, ensuring consistency across multiple languages, and identifying issues in translation workflows. Teams can use the API to streamline QA processes in multilingual projects.
Users can review the returned issue list, severity values, affected keys, locales, source values, target values, placeholder details, ICU details, and warnings to identify localization items that may need review.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund
Service Level:
100%
Response Time:
980ms
Service Level:
100%
Response Time:
371ms
Service Level:
100%
Response Time:
1,105ms
Service Level:
100%
Response Time:
47ms
Service Level:
100%
Response Time:
192ms
Service Level:
100%
Response Time:
84ms
Service Level:
100%
Response Time:
6,819ms
Service Level:
100%
Response Time:
10,210ms
Service Level:
100%
Response Time:
2,521ms
Service Level:
100%
Response Time:
669ms