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

# Restore an uploaded backup file as a new project

> Restores an uploaded backup file as a new project in the caller's shop. Send `multipart/form-data` with exactly one `file` part: a backup as downloaded from `GET /projects/{projectId}/backups?backupId=` (brotli or plain JSON).

- Creates a new project and never overwrites an existing one, so no confirmation is required.
- Shop-level: there is no project id in the path. Project-bound agent tokens are never accepted.
- Upload at most 50 MB; decompressed at most 256 MB. The whole multipart body is byte-capped while streaming, and a second file part is rejected.
- 400 when the file is not a readable Weaverse backup or uses an unsupported backup schema; 415 when the body is not `multipart/form-data`.

Required scope: `project:manage`



## OpenAPI

````yaml https://studio.weaverse.io/api/v1/content/openapi.json post /backup-restores
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:
  /backup-restores:
    summary: Restore an uploaded backup file as a NEW project (project:manage)
    description: >-
      multipart/form-data file: a backup as downloaded from GET
      /projects/{projectId}/backups?backupId= (brotli or plain JSON). Creates a
      new project in the caller's shop; never overwrites. Upload <= 50MB,
      decompressed <= 256MB. The whole multipart body is byte-capped while
      streaming; a second file part is rejected.
    post:
      tags:
        - Backups and portability
      summary: Restore an uploaded backup file as a new project
      description: >-
        Restores an uploaded backup file as a new project in the caller's shop.
        Send `multipart/form-data` with exactly one `file` part: a backup as
        downloaded from `GET /projects/{projectId}/backups?backupId=` (brotli or
        plain JSON).


        - Creates a new project and never overwrites an existing one, so no
        confirmation is required.

        - Shop-level: there is no project id in the path. Project-bound agent
        tokens are never accepted.

        - Upload at most 50 MB; decompressed at most 256 MB. The whole multipart
        body is byte-capped while streaming, and a second file part is rejected.

        - 400 when the file is not a readable Weaverse backup or uses an
        unsupported backup schema; 415 when the body is not
        `multipart/form-data`.


        Required scope: `project:manage`
      operationId: restoreBackupFile
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '201':
          description: Restored
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    const: project_restored
                  newProjectId:
                    type: string
              example:
                object: project_restored
                newProjectId: clz9b4c5d0012trew1qaz2wsx
        '400':
          description: Not a readable Weaverse backup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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'
        '413':
          description: File too large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: Not multipart/form-data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Restore failed (INTERNAL_ERROR)
          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.