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
Catalogs
A Catalog is a string catalog: one source locale, its target locales, and how to translate them.
A Catalog is a string catalog: one source locale, its target locales, and how to translate them. Its entries are written by :sync; :export returns the files per locale.
Service Sylphx Localization · Resource type localization.sylphx.com/Catalog · Name pattern orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}. |
uid | string | cat_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | CatalogSpec | Desired state. Required. |
status | CatalogStatus | Observed state. Output only. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a catalog. |
GET | list | Lists catalogs. |
POST | create | Creates a catalog. |
PATCH | update | Updates a catalog. |
DELETE | delete | Deletes a catalog. |
POST | sync | Reads the source files and the committed translations into the catalog, then translates what is new or stale. Each call is idempotent and works within a bounded time; call again until pending is 0. |
POST | export | Returns the catalog's files per locale in the requested format, with the QA report. A read with a request body, like a query. |
#get
Gets a catalog.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:read · effect read · Request, response and examples
#list
Lists catalogs.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs · scope localization:read · effect read · paginated · Request, response and examples
#create
Creates a catalog.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs · scope localization:write · effect write · Request, response and examples
#update
Updates a catalog.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:write · effect write · Request, response and examples
#delete
Deletes a catalog.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog · scope localization:write · effect destructive · Request, response and examples
#sync
Reads the source files and the committed translations into the catalog, then translates what is new or stale. Each call is idempotent and works within a bounded time; call again until pending is 0.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:sync · scope localization:write · effect write · Request, response and examples
#export
Returns the catalog's files per locale in the requested format, with the QA report. A read with a request body, like a query.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog:export · scope localization:read · effect read · Request, response and examples