Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Catalog
ResourceMeta
CatalogSpec
Response
ResourceMeta
CatalogSpec
CatalogStatus
Condition
LocaleProgress
Errors
Examples

Reference

Create a catalog

Creates a catalog.

Checked 2026-09-28

Creates a catalog.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs
Scope localization:write
Effect write — a successful call changes state.
Collection catalogs
Query catalog_id, validate_only

#Request

Field	Type	What it is
`parent`	`string`	The parent to create in. Required.
`catalog_id`	`string`	The catalog id, the final name segment; the server assigns one when empty.
`catalog`	`Catalog`	The catalog to create; only caller-writable fields are read. Required.
`validate_only`	`bool`	Validate and return the result without writing anything.

#Catalog

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`CatalogSpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.

#CatalogSpec

Field	Type	What it is
`source_locale`	`string`	The locale the source texts are written in, a BCP 47 tag such as `en`. Required.
`target_locales`	`string[]`	The locales to translate into, BCP 47 tags. `zh-Hant-HK` and `zh-Hant-TW` are separate locales. At most 60, each once.
`pseudo_locales`	`PseudoLocale[]`	Pseudo-locales to generate at export. They are never stored or translated. One of `accented`, `bidi`, `wide`.
`tone`	`string`	The brand voice every translation follows, at most 2000 characters.
`locale_guidance`	`map<string, string>`	Extra instructions per target locale, for example the vocabulary of a region. Keys are target locales; at most 60 entries, each at most 2000 characters.
`glossaries`	`string[]`	The glossaries this catalog applies, as Glossary names; at most 10.

#Response

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.

#ResourceMeta

Field	Type	What it is
`generation`	`int64`	Increases by one on every change to `spec`. Output only.
`etag`	`string`	Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only.
`create_time`	`timestamp`	When the Resource was created. Output only.
`update_time`	`timestamp`	When the Resource last changed. Output only.
`delete_time`	`timestamp`	Set while the Resource is being deleted. Output only.
`labels`	`map<string, string>`	Caller-writable, indexed labels (AIP-122 label rules).
`annotations`	`map<string, string>`	Caller-writable, unindexed annotations.
`display_name`	`string`	Caller-writable human-readable name.
`creator`	`string`	The principal that created the Resource. Output only.

#CatalogSpec

Field	Type	What it is
`source_locale`	`string`	The locale the source texts are written in, a BCP 47 tag such as `en`. Required.
`target_locales`	`string[]`	The locales to translate into, BCP 47 tags. `zh-Hant-HK` and `zh-Hant-TW` are separate locales. At most 60, each once.
`pseudo_locales`	`PseudoLocale[]`	Pseudo-locales to generate at export. They are never stored or translated. One of `accented`, `bidi`, `wide`.
`tone`	`string`	The brand voice every translation follows, at most 2000 characters.
`locale_guidance`	`map<string, string>`	Extra instructions per target locale, for example the vocabulary of a region. Keys are target locales; at most 60 entries, each at most 2000 characters.
`glossaries`	`string[]`	The glossaries this catalog applies, as Glossary names; at most 10.

#CatalogStatus

Field	Type	What it is
`observed_generation`	`int64`	The generation this status was computed from. Output only.
`conditions`	`Condition[]`	Ready, Reconciling, Stalled. Output only.
`entry_count`	`int32`	The number of active entries. Output only.
`locales`	`LocaleProgress[]`	Progress per target locale. Output only.
`last_sync_time`	`timestamp`	When `:sync` last completed. Output only.

#Condition

Field	Type	What it is
`type`	`string`	The condition type, for example `Ready`.
`status`	`ConditionStatus`	Whether the condition holds. One of `true`, `false`, `unknown`.
`observed_generation`	`int64`	The generation this observation was made against.
`reason`	`string`	A machine-readable UpperCamelCase reason.
`message`	`string`	A customer-safe human-readable message.
`severity`	`Severity`	How severe a FALSE condition is. One of `info`, `warning`, `error`.
`transition_time`	`timestamp`	When `status` last changed.

#LocaleProgress

Field	Type	What it is
`locale`	`string`	The target locale. Output only.
`translated`	`int32`	Entries with a translation that passed QA. Output only.
`pending`	`int32`	Entries still to translate. Output only.
`failed`	`int32`	Entries whose translation still fails QA after repair. Output only.
`pinned`	`int32`	Entries with a human-pinned translation. Output only.

#Errors

UNAUTHENTICATED — No valid key or token was presented.
PERMISSION_DENIED — The key lacks the method's permission.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"source_locale":"…"}}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links