> ## 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

# Get a page's editable content and revision tokens

> Returns the content you should edit for one page, plus the revision tokens that a later save must send back unchanged. This is step 1 of draft-first editing.

**Workflow.** Drafts and publishing work together like this:

1. `GET /projects/{projectId}/page-drafts/{pageId}` reads the editable content and its revision tokens.
2. `PUT` on the same path saves a new draft head (`versionId`). Live content is not touched.
3. Publish the draft with `POST /publish-versions/{versionId}`, or schedule it with `POST /versions/{versionId}/schedule`.
4. Manage history and the schedule with `GET /projects/{projectId}/versions`, `/versions/{versionId}` (read, reschedule, replace content, cancel), `publish-now` and `restore`.

**What is returned**

- When the page has a draft head: the draft's items, with `headVersionId` set to that draft. `pageUpdatedAt` and `projectUpdatedAt` are the live revisions the draft was built on, not the current live revisions. If live content has changed since the draft was saved, a save from this read is refused with 409 `STALE_PAGE`, so a draft can never quietly publish over a newer live edit.
- When there is no draft: the live items, with `headVersionId: null` and the current live `pageUpdatedAt` / `projectUpdatedAt`.
- Items are a flat list. Each item has `id`, `type`, `data` and `children` (child id references). `rootId` names the root item.
- `pageUpdatedAt` or `projectUpdatedAt` is `null` for a legacy row whose revision was never set. Send that `null` back as is. A read never repairs it.

**Addressing.** The page is addressed by `pageId` only. There is no locale or handle fallback, so a draft can never be read from or saved onto another assignment. A page that is not a live page of this project, or a draft head whose snapshot cannot be read, returns 404.

Required scope: `content:read`



## OpenAPI

````yaml https://studio.weaverse.io/api/v1/content/openapi.json get /projects/{projectId}/page-drafts/{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-drafts/{pageId}:
    summary: Read the editable content / save or discard a page draft
    description: >-
      GET returns the current draft head when one exists, else live content,
      plus the revision tokens a save must replay: headVersionId, pageUpdatedAt
      and projectUpdatedAt. With a draft head, the page and project tokens are
      the live revisions that draft was built on (not the current live ones), so
      a save is refused once live moved past it. PUT saves a draft from a full
      item list (each item: id, type, optional children id refs and record data;
      malformed graphs are 400) (content:write; never touches live). DELETE
      discards the draft head by exact CAS. Addressing is by pageId — no
      locale/handle fallback, so a draft can never land on another assignment.
      projectUpdatedAt is null for a legacy project whose revision was never
      set; the draft save then records that null base (GET never repairs it).
    parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: pageId
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Drafts and publishing
      summary: Get a page's editable content and revision tokens
      description: >-
        Returns the content you should edit for one page, plus the revision
        tokens that a later save must send back unchanged. This is step 1 of
        draft-first editing.


        **Workflow.** Drafts and publishing work together like this:


        1. `GET /projects/{projectId}/page-drafts/{pageId}` reads the editable
        content and its revision tokens.

        2. `PUT` on the same path saves a new draft head (`versionId`). Live
        content is not touched.

        3. Publish the draft with `POST /publish-versions/{versionId}`, or
        schedule it with `POST /versions/{versionId}/schedule`.

        4. Manage history and the schedule with `GET
        /projects/{projectId}/versions`, `/versions/{versionId}` (read,
        reschedule, replace content, cancel), `publish-now` and `restore`.


        **What is returned**


        - When the page has a draft head: the draft's items, with
        `headVersionId` set to that draft. `pageUpdatedAt` and
        `projectUpdatedAt` are the live revisions the draft was built on, not
        the current live revisions. If live content has changed since the draft
        was saved, a save from this read is refused with 409 `STALE_PAGE`, so a
        draft can never quietly publish over a newer live edit.

        - When there is no draft: the live items, with `headVersionId: null` and
        the current live `pageUpdatedAt` / `projectUpdatedAt`.

        - Items are a flat list. Each item has `id`, `type`, `data` and
        `children` (child id references). `rootId` names the root item.

        - `pageUpdatedAt` or `projectUpdatedAt` is `null` for a legacy row whose
        revision was never set. Send that `null` back as is. A read never
        repairs it.


        **Addressing.** The page is addressed by `pageId` only. There is no
        locale or handle fallback, so a draft can never be read from or saved
        onto another assignment. A page that is not a live page of this project,
        or a draft head whose snapshot cannot be read, returns 404.


        Required scope: `content:read`
      operationId: getPageDraft
      responses:
        '200':
          description: Draft basis (draft snapshot or live items)
          content:
            application/json:
              schema:
                type: object
              example:
                object: page_draft
                pageId: clz7pg9k2m4n6p8r0t2v4x6z
                projectId: clz7prj0a1b2c3d4e5f6g7h8
                name: Home
                rootId: root-1
                items:
                  - id: root-1
                    type: main
                    children:
                      - id: hero-1
                    data: {}
                  - id: hero-1
                    type: hero-image
                    data:
                      heading: Summer collection
                      height: large
                pageUpdatedAt: '2026-10-08T10:00:00.000Z'
                projectUpdatedAt: '2026-10-08T09:00:00.000Z'
                headVersionId: clz9drf1q3s5u7w9y1a3c5e7
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Foreign project or missing scope (INSUFFICIENT_SCOPE)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found (never discloses other tenants)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    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.
  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.