GET /v1/i18n/documents/{locale}

認証

このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/i18n/documents/{locale}?object_ref=<object_ref>

ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Returns the finished translations for a single document, as field -> text across the surfaces a rendered page is built from (page, meta_title, meta_description, alt_text) — the read the public site performs on the server, per page, at render time. Why a second public endpoint next to getPublicMessageCatalogue. They are cached on different keys and answer different questions. The catalogue is one response per locale covering the shell (nav, footer, meta) and is read on every page; this is one response per document per locale, read only by the page it belongs to. Folding them together would churn the shell's cache entry whenever any of 60 marketing pages was retranslated. ⛔ object_ref is required. One locale's whole page surface is ~7,879 entries — the read scripts/i18n-pages.mjs batches at build time, and the one that OOM-killed the engine on 2026-08-05. Making the parameter optional would re-create that on a public, unauthenticated URL. A single document is ~131 leaves, which is what makes this safe on a render path behind an edge cache. Public and non-tenant, for the same reasons as the catalogue: the text is already in the page's HTML, and an Authorization header suppresses shared caching. up_to_date only — the site applies this over the document the current deploy already serves, so stale text could only replace a good translation with an older one. An untranslated document is a 200 with an empty fields object, never a 404 — the caller treats any failure as "use the build-time document", so a 404 would be indistinguishable from an outage. Cacheable: strong ETag plus Cache-Control: public, max-age=300, stale-while-revalidate=86400.

パラメータ

返信

このエンドポイントが返すエラー

422 · 429