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

# Rename a page or update its SEO

> Updates one page's metadata, selected by `op`. These are live writes: they change labels, routes or SEO immediately and do not go through the page draft. They never publish page content.

Operations:

- `rename`: sets the page `name` (1-191 characters) and `prefix`. Omitting `prefix` clears it.
- `rename-custom`: renames a CUSTOM page and changes its URL handle. Requires `name`, `handle` and the `assignmentId` of the CUSTOM assignment to change. Returns the handle actually written. A non-CUSTOM page returns `400`; a handle already used by another custom page returns `409 CONFLICT`. A page version is recorded after the rename.
- `set-seo`: upserts the page SEO. `seo` accepts `title` (max 70), `description` (max 320), `keywords` (max 500), `canonicalUrl` (URL), `openGraph` (`title` max 90, `description` max 200, `image` URL, `type`: `website`, `article`, `product`, `profile` or `video.other`), `twitter` (`cardType`: `summary`, `summary_large_image`, `app` or `player`; `title` max 70, `description` max 200, `image` URL) and `robots` (`index`, `follow` booleans). Empty strings are treated as unset.

Only pages this project owns exclusively can be changed; others return `404`.

Required scope: `content:write`



## OpenAPI

````yaml https://studio.weaverse.io/api/v1/content/openapi.json post /projects/{projectId}/page-settings/{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-settings/{pageId}:
    summary: 'Page metadata: name/prefix, custom rename, SEO (content:write)'
    parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: pageId
        in: path
        required: true
        schema:
          type: string
    post:
      tags:
        - Page settings
      summary: Rename a page or update its SEO
      description: >-
        Updates one page's metadata, selected by `op`. These are live writes:
        they change labels, routes or SEO immediately and do not go through the
        page draft. They never publish page content.


        Operations:


        - `rename`: sets the page `name` (1-191 characters) and `prefix`.
        Omitting `prefix` clears it.

        - `rename-custom`: renames a CUSTOM page and changes its URL handle.
        Requires `name`, `handle` and the `assignmentId` of the CUSTOM
        assignment to change. Returns the handle actually written. A non-CUSTOM
        page returns `400`; a handle already used by another custom page returns
        `409 CONFLICT`. A page version is recorded after the rename.

        - `set-seo`: upserts the page SEO. `seo` accepts `title` (max 70),
        `description` (max 320), `keywords` (max 500), `canonicalUrl` (URL),
        `openGraph` (`title` max 90, `description` max 200, `image` URL, `type`:
        `website`, `article`, `product`, `profile` or `video.other`), `twitter`
        (`cardType`: `summary`, `summary_large_image`, `app` or `player`;
        `title` max 70, `description` max 200, `image` URL) and `robots`
        (`index`, `follow` booleans). Empty strings are treated as unset.


        Only pages this project owns exclusively can be changed; others return
        `404`.


        Required scope: `content:write`
      operationId: updatePageSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageSettingsOperation'
            example:
              op: rename
              name: About
            examples:
              rename:
                summary: Rename a page
                value:
                  op: rename
                  name: About
              rename-custom:
                summary: Rename a custom page and change its handle
                value:
                  op: rename-custom
                  name: Our story
                  handle: our-story
                  assignmentId: clz8r5t6u0005pa01abou0001
              set-seo:
                summary: Set page SEO
                value:
                  op: set-seo
                  seo:
                    title: Our story
                    description: Who we are and how we make our products.
                    openGraph:
                      title: Our story
                      type: website
                    robots:
                      index: true
                      follow: true
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
              example:
                object: page_settings_updated
                pageId: clz8q1m2n0004pg01abou0003
                handle: our-story
        '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'
        '409':
          description: CONFLICT — handle already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                object: error
                code: CONFLICT
                message: 'Page already exists: CUSTOM/our-story'
                status: 409
components:
  schemas:
    PageSettingsOperation:
      type: object
      required:
        - op
      oneOf:
        - type: object
          required:
            - op
            - name
          properties:
            op:
              const: rename
            name:
              type: string
            prefix:
              type: string
        - type: object
          required:
            - op
            - name
            - handle
            - assignmentId
          properties:
            op:
              const: rename-custom
            name:
              type: string
            handle:
              type: string
            assignmentId:
              type: string
        - type: object
          required:
            - op
            - seo
          properties:
            op:
              const: set-seo
            seo:
              type: object
    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.