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

# List, download or diff project backups

> Read-only access to the project's point-in-time backups. One endpoint, three modes:

- No query: lists backups, newest first, as `{ object: "list", data: [{ id, byteSize, trigger, createdAt }] }`. `trigger` is one of `SCHEDULED`, `PRE_DELETE`, `PRE_RESET`, `PRE_PUBLISH`, `MANUAL`.
- `?backupId=<id>`: downloads the stored backup as a brotli-compressed file (`application/x-brotli`, `attachment`). This is the file `POST /backup-restores` accepts.
- `?diff=<id>`: compares that backup with the live project and returns `{ object: "backup_diff", backupId, diff }`. `diff` has `added`/`removed`/`changed`/`unchanged` counts for `pages`, `items`, `translations`, `globalSections` and `languages` (with named `changes` where a label exists, capped), `theme.changed`, and `hasChanges`.

A backup id is resolved through this project and the caller's shop before any storage read; an unknown or foreign id returns 404.

Required scope: `project:manage`



## OpenAPI

````yaml https://studio.weaverse.io/api/v1/content/openapi.json get /projects/{projectId}/backups
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}/backups:
    summary: List/create/download/diff backups; restore as new project
    description: >-
      project:manage. GET lists; ?backupId= downloads; ?diff=<backupId> diffs
      against live. POST {op:"create"} is a deduped "backup now"; {op:"restore",
      backupId} restores as a NEW project under the shop (never overwrites).
    parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: backupId
        in: query
        schema:
          type: string
      - name: diff
        in: query
        schema:
          type: string
    get:
      tags:
        - Backups and portability
      summary: List, download or diff project backups
      description: >-
        Read-only access to the project's point-in-time backups. One endpoint,
        three modes:


        - No query: lists backups, newest first, as `{ object: "list", data: [{
        id, byteSize, trigger, createdAt }] }`. `trigger` is one of `SCHEDULED`,
        `PRE_DELETE`, `PRE_RESET`, `PRE_PUBLISH`, `MANUAL`.

        - `?backupId=<id>`: downloads the stored backup as a brotli-compressed
        file (`application/x-brotli`, `attachment`). This is the file `POST
        /backup-restores` accepts.

        - `?diff=<id>`: compares that backup with the live project and returns
        `{ object: "backup_diff", backupId, diff }`. `diff` has
        `added`/`removed`/`changed`/`unchanged` counts for `pages`, `items`,
        `translations`, `globalSections` and `languages` (with named `changes`
        where a label exists, capped), `theme.changed`, and `hasChanges`.


        A backup id is resolved through this project and the caller's shop
        before any storage read; an unknown or foreign id returns 404.


        Required scope: `project:manage`
      operationId: listBackups
      responses:
        '200':
          description: >-
            Backup list, or the diff for ?diff=. ?backupId= downloads the stored
            backup as a brotli-compressed JSON attachment
            (application/x-brotli).
          content:
            application/json:
              schema:
                type: object
              example:
                object: list
                data:
                  - id: clz9a1b2c0010mnbv5cxz4lkj
                    byteSize: 48213
                    trigger: MANUAL
                    createdAt: '2026-10-18T09:12:44.000Z'
                  - id: clz9a0f8e0009hgfd3sap2oiu
                    byteSize: 47980
                    trigger: SCHEDULED
                    createdAt: '2026-10-17T21:00:03.000Z'
            application/x-brotli:
              schema:
                type: string
                format: binary
        '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.