---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Catalogs"
description: "The `catalogs` collection of Sylphx Localization: A Catalog is a string catalog: one source locale, its target locales, and how to translate them."
type: reference
product: localization
summary: "A Catalog is a string catalog: one source locale, its target locales, and how to translate them."
updated: 2026-09-28
order: 900
---

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`](/docs/api/catalogs#get) | Gets a catalog. |
| `GET` | [`list`](/docs/api/catalogs#list) | Lists catalogs. |
| `POST` | [`create`](/docs/api/catalogs#create) | Creates a catalog. |
| `PATCH` | [`update`](/docs/api/catalogs#update) | Updates a catalog. |
| `DELETE` | [`delete`](/docs/api/catalogs#delete) | Deletes a catalog. |
| `POST` | [`sync`](/docs/api/catalogs#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`](/docs/api/catalogs#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](/docs/api/catalogs/get)

## 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](/docs/api/catalogs/list)

## 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](/docs/api/catalogs/create)

## 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](/docs/api/catalogs/update)

## 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](/docs/api/catalogs/delete)

## 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](/docs/api/catalogs/sync)

## 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](/docs/api/catalogs/export)