Skip to content
Console
On this page

Entries

A Catalog Entry is one source message and its translations.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A Catalog Entry is one source message and its translations. :sync writes it; it is never created directly. Its id is a stable hash of the file and key, assigned by the server.

Service Sylphx Localization · Resource type localization.sylphx.com/CatalogEntry · Name pattern orgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}/entries/{entry} · Shape record

Not available yet. Sylphx Localization is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/catalogs/{catalog}/entries/{entry}.
uidstringent_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
keystringThe source text plus an optional |context, or an id for id-keyed formats. Output only.
filestringThe source file's path within the upload; empty for a single-file catalog. Output only.
source_textstringThe source message, a Unicode MessageFormat 2 pattern. Output only.
contextstringDisambiguates the same text with different meanings. Output only.
descriptionstringA note for translators. Output only.
max_lengthint32The longest a translation may be, in characters; 0 is no limit. Output only.
source_hashstringThe first 16 lowercase hex characters of the SHA-256 of the UTF-8 source pattern. A translation is stale when its source hash differs. Output only.
stateEntryStateWhether the source still has this message. Output only. One of active, obsolete.
translationsTranslation[]The translations, one per target locale at most. Output only.
create_timetimestampWhen the entry was first synced. Output only.
update_timetimestampWhen the entry last changed. 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.

MethodCallWhat it does
GETgetGets a catalog entry.
GETlistLists catalog entries. The filter is limited to state, locale, and qa_state.
POSTpin_translationSets the text of one locale as a human override that AI never overwrites. QA runs on the text first; a text with a QA error is rejected with INVALID_FIELD, and the problem lists the findings.
POSTunpin_translationRemoves the human override of one locale; the next sync may translate it again.

get

Gets a catalog entry.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry · scope localization:read · effect read · not available yet · Request, response and examples

list

Lists catalog entries. The filter is limited to state, locale, and qa_state.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries · scope localization:read · effect read · not available yet · paginated · Request, response and examples

pin_translation

Sets the text of one locale as a human override that AI never overwrites. QA runs on the text first; a text with a QA error is rejected with INVALID_FIELD, and the problem lists the findings.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry:pinTranslation · scope localization:write · effect write · not available yet · Request, response and examples

unpin_translation

Removes the human override of one locale; the next sync may translate it again.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/catalogs/catalog/entries/entry:unpinTranslation · scope localization:write · effect write · not available yet · Request, response and examples