> ## Documentation Index > Fetch the complete documentation index at: https://weaverse.io/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Weaverse component configuration uses `settings`. `inspector` is deprecated; never generate it. > Weaverse Hydrogen themes use React Router v7: import from `react-router`, never `react-router-dom` or `@remix-run/*`. > Define component schemas with `createSchema()` from `@weaverse/hydrogen` (React Router themes) or `@weaverse/next` (Next.js themes). > These docs cover @weaverse/hydrogen, @weaverse/react and @weaverse/core 5.x, and @weaverse/next 1.x. Do not use APIs from other major versions. > For live project data (pages, theme settings, translations), use the Weaverse MCP server: https://docs.weaverse.io/developer-tools/weaverse-mcp # Read a page's translations for one locale > Returns every translatable text key of an owned page for one configured target locale: the source text the runtime translates from, the current target text, and the `targetGeneration` a writeback must replay. - Sources are resolved server-side from the item value, its component-schema default, or the project default language overlay (whichever the runtime actually translates from). Client-supplied schemas or bare item ids are never trusted. - `translation: null` means no row exists, or the stored one answers a source the merchant has since changed. `""` is a deliberate clear. - `targetGeneration` is the raw stored target value at read time (`null` = no row, `""` = cleared). Replay it verbatim on `POST`. - `language.isDefault` is `true` when the locale is the project default language; `POST` refuses to write it. - Not cached: a cached generation would guarantee a stale write. - Text only. Image translations are not exposed here; use `GET /projects/{projectId}/translation-units?kind=image`. Workflow: `GET` this page and locale, change `translation` on the entries you want to write, `POST` them back unchanged otherwise, then `GET` again to confirm. Required scope: `content:read` ## OpenAPI ````yaml https://studio.weaverse.io/api/v1/content/openapi.json get /projects/{projectId}/page-translations/{pageId} openapi: 3.1.0 info: title: Weaverse Content API version: 1.0.0 description: >- Authenticated REST API for querying Weaverse-managed content (projects, pages, theme settings, languages) and for reading and writing per-locale translations. servers: - url: https://studio.weaverse.io/api/v1/content description: Production security: - bearerAuth: [] tags: - name: Projects description: List, read, rename, create, copy and delete projects. - name: Pages description: List, read, create, update and delete the pages of a project. - name: Drafts and publishing description: >- Edit page drafts, then publish, schedule, restore and manage page versions. - name: Global sections description: Read, edit and publish sections shared across pages. - name: Page settings description: Read and edit page-level settings such as SEO metadata. - name: Assignments description: Map Shopify resources and routes to Weaverse pages and templates. - name: Theme settings description: Read and update a project's theme settings. - name: Languages and localization description: List project languages and manage locales, static text and glossary. - name: Translations description: >- Read and write per-locale translations, built for external translation agents. - name: Project structure description: Manage project variants and the project hierarchy. - name: Backups and portability description: Back up, restore, export and import project content. - name: Previews and hostnames description: Create preview links and manage the hostnames a project accepts. - name: Specification description: This OpenAPI document. paths: /projects/{projectId}/page-translations/{pageId}: get: tags: - Translations summary: Read a page's translations for one locale description: >- Returns every translatable text key of an owned page for one configured target locale: the source text the runtime translates from, the current target text, and the `targetGeneration` a writeback must replay. - Sources are resolved server-side from the item value, its component-schema default, or the project default language overlay (whichever the runtime actually translates from). Client-supplied schemas or bare item ids are never trusted. - `translation: null` means no row exists, or the stored one answers a source the merchant has since changed. `""` is a deliberate clear. - `targetGeneration` is the raw stored target value at read time (`null` = no row, `""` = cleared). Replay it verbatim on `POST`. - `language.isDefault` is `true` when the locale is the project default language; `POST` refuses to write it. - Not cached: a cached generation would guarantee a stale write. - Text only. Image translations are not exposed here; use `GET /projects/{projectId}/translation-units?kind=image`. Workflow: `GET` this page and locale, change `translation` on the entries you want to write, `POST` them back unchanged otherwise, then `GET` again to confirm. Required scope: `content:read` operationId: getPageTranslations parameters: - name: projectId in: path required: true schema: type: string - name: pageId in: path required: true schema: type: string description: The page id (from `GET /projects/{projectId}/pages`). - name: locale in: query required: true schema: type: string description: >- A configured target locale, e.g. `en-us` (see `GET /projects/{projectId}/languages`). responses: '200': description: Translatable keys with current targets and their generations content: application/json: schema: $ref: '#/components/schemas/PageTranslationsResponse' example: object: page_translations projectId: clz8k2m4n0001qwer7tyu8iop pageId: clz8k3a1b0004asdf5ghj6klz language: id: clz8k2x7y0003lkjh4gfd3sap code: fr-fr name: French isDefault: false data: - itemId: clz8k3c9d0007zxcv8bnm1qwe key: data.heading source: Summer collection translation: Collection été targetGeneration: Collection été - itemId: clz8k3d2e0008poiu7ytr6ewq key: data.buttonText source: Shop now translation: null targetGeneration: null '400': description: Missing `locale`, or a locale this project has not configured content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Project not found, or the page is not owned by this project content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Unexpected server error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: PageTranslationsResponse: type: object properties: object: type: string enum: - page_translations projectId: type: string pageId: type: string language: type: object description: The resolved target language row, not the requested string. properties: id: type: string code: type: string name: type: string isDefault: type: boolean description: >- True when this locale is the project default — the source other locales translate from, which POST refuses to write. Derived from the project configuration, the same authority the write path rejects on. data: type: array items: $ref: '#/components/schemas/PageTranslationEntry' Error: type: object required: - object - code - message - status properties: object: type: string enum: - error code: type: string enum: - UNAUTHORIZED - FORBIDDEN - INSUFFICIENT_SCOPE - PROJECT_NOT_FOUND - PAGE_NOT_FOUND - STALE_PAGE - STALE_PROJECT - STALE_TRANSLATION - TRANSLATION_UNIT_NOT_FOUND - SERVICE_UNAVAILABLE - CONFLICT - PRECONDITION_REQUIRED - INVALID_PARAMS - INTERNAL_ERROR message: type: string status: type: integer details: description: >- Optional machine-readable context, for example the clashing handles of a 409 CONFLICT. PageTranslationEntry: type: object required: - itemId - key - source - translation - targetGeneration properties: itemId: type: string description: The item the key belongs to. key: type: string description: >- The extraction path of the translatable field, rooted at the item data column (e.g. `data.title`). Use it verbatim; it is the stored translation key. source: type: string description: >- The text the translation answers for, resolved server-side from the item value, its component-schema default, or the project default language overlay — whichever the runtime actually translates FROM. translation: type: - string - 'null' description: >- The current target text. `""` is a deliberate clear; `null` means no row exists, or the stored one answers a source the merchant has since changed. targetGeneration: type: - string - 'null' description: >- The raw stored target value at read time, independent of freshness: `null` = no row, `""` = cleared. Replay it verbatim on write; it is the compare-and-set token that stops a delayed agent overwriting a newer translation. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: WEAVERSE_API_KEY description: >- Bearer authentication: a shop API key (WEAVERSE_API_KEY), a scoped API key, a delegated MCP OAuth token, or (translation-unit routes only) a project-bound translation agent token. Scopes: content:read — Read projects, pages, theme settings, versions, drafts and translation units. content:write — Save drafts and make non-destructive edits (page items, metadata, SEO, assignments, languages, glossary). Never publishes or deletes. content:publish — Publish drafts, schedule/reschedule/cancel publications, restore versions, publish global sections. content:delete — Delete pages, global sections, languages, static keys, override reverts; required with project:manage for project deletion. project:manage — Create/copy/delete projects, settings, variants, hierarchy, backups, restore-as-new, previews, hostname policy. translations:read — Read translation units only (no general content access). translations:write — Apply translation units only; never mutates page content. A legacy unscoped API key keeps read/write/translation baseline access and every pre-scope endpoint, but never gains publish/delete/project-manage implicitly. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.