Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Export a catalog
Returns the catalog's files per locale in the requested format, with the QA report.
Returns the catalog's files per locale in the requested format, with the QA report. A read with a request body, like a query.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:export - Scope
localization:read - Effect
read— nothing is written. - Collection catalogs
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the catalog. Required. |
format | Format | The format of the files. Required. One of sylphx_json, icu_json, gettext_po, xliff2. |
locales | string[] | The locales to export; default every target locale and the pseudo-locales. |
source_fallback | bool | Emit the source text for keys that have no passing translation, for runtimes that do not fall back to the source themselves. |
#Response
| Field | Type | What it is |
|---|---|---|
files | CatalogFile[] | One file per source file per locale, with the source file's path. |
report | QaReport | The QA report. A translation with an error is never exported. |
pending | int32 | Translations still to make. |
glyph_sets | GlyphSet[] | The characters each locale's texts use. |
#CatalogFile
| Field | Type | What it is |
|---|---|---|
path | string | The file's path. The service does not interpret it and echoes it back, for example a namespace file name. Required. |
locale | string | The file's locale, a BCP 47 tag. Required. |
content | string | The file's text, UTF-8; at most 4 MiB. Required. |
#QaReport
| Field | Type | What it is |
|---|---|---|
passed | bool | Whether there are no errors. |
errors | int32 | The number of errors. |
warnings | int32 | The number of warnings. |
findings | QaFinding[] | The findings. |
#GlyphSet
| Field | Type | What it is |
|---|---|---|
locale | string | The locale. |
characters | string | Every distinct character the locale's texts use, sorted. |
#QaFinding
| Field | Type | What it is |
|---|---|---|
entry | string | The Catalog Entry, as a resource name. Output only. |
key | string | The entry's key. Output only. |
locale | string | The target locale. Output only. |
check | QaCheck | The check that found it. Output only. One of syntax, placeholders, markup, plural, length, glossary, forbidden_term. |
severity | QaSeverity | How serious it is. Output only. One of error, warning. |
message | string | What is wrong. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:export" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"format":"sylphx_json"}'