> ## 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 # Create, update or delete a preview URL > One endpoint for preview URL writes, selected by `op`: - `create` (`name`, `url`, optional `isDefault`): returns 201 `{ object: "preview_url", previewUrl }`. 409 when the project already has a preview with this URL. Setting `isDefault: true` unsets the previous default. - `update` (`id`, optional `name`, `url`, `isDefault`): returns 200 `{ object: "preview_url", previewUrl }`. 409 when another preview of this project already has the new URL. - `delete` (`id`): returns 200 `{ object: "preview_url_deleted", id }`. Permanent. `name` is at most 191 characters and `url` at most 2048. Ids are resolved through this project; an id from another project returns 404. Required scope: `project:manage` ## OpenAPI ````yaml https://studio.weaverse.io/api/v1/content/openapi.json post /projects/{projectId}/previews 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}/previews: summary: 'Preview URLs: list (pure read) and CRUD (project:manage)' parameters: - name: projectId in: path required: true schema: type: string post: tags: - Previews and hostnames summary: Create, update or delete a preview URL description: >- One endpoint for preview URL writes, selected by `op`: - `create` (`name`, `url`, optional `isDefault`): returns 201 `{ object: "preview_url", previewUrl }`. 409 when the project already has a preview with this URL. Setting `isDefault: true` unsets the previous default. - `update` (`id`, optional `name`, `url`, `isDefault`): returns 200 `{ object: "preview_url", previewUrl }`. 409 when another preview of this project already has the new URL. - `delete` (`id`): returns 200 `{ object: "preview_url_deleted", id }`. Permanent. `name` is at most 191 characters and `url` at most 2048. Ids are resolved through this project; an id from another project returns 404. Required scope: `project:manage` operationId: previewUrlOperation requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PreviewUrlOperation' example: op: create name: Local url: http://localhost:3456 examples: create: summary: Add a preview URL value: op: create name: Local url: http://localhost:3456 update: summary: Make a preview the default value: op: update id: clz9d8f9g0016qaz3wsx4edc isDefault: true delete: summary: Delete a preview URL value: op: delete id: clz9d8f9g0016qaz3wsx4edc responses: '200': description: Operation result content: application/json: schema: type: object '201': description: Created content: application/json: schema: type: object example: object: preview_url previewUrl: id: clz9d8f9g0016qaz3wsx4edc name: Local url: http://localhost:3456 sandboxId: null isDefault: false projectId: clz8k2m4n0001qwer7tyu8iop createdAt: '2026-10-20T10:15:00.000Z' updatedAt: '2026-10-20T10:15:00.000Z' '400': description: Invalid body (INVALID_PARAMS) 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' '404': description: Not found (never discloses other tenants) content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- CONFLICT: another preview URL of this project has this address (create or update) content: application/json: schema: $ref: '#/components/schemas/Error' example: object: error code: CONFLICT message: A preview URL with this address already exists status: 409 components: schemas: PreviewUrlOperation: type: object required: - op oneOf: - type: object required: - op - name - url properties: op: const: create name: type: string url: type: string isDefault: type: boolean - type: object required: - op - id properties: op: const: update id: type: string name: type: string url: type: string isDefault: type: boolean - type: object required: - op - id properties: op: const: delete id: type: string 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.