> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fluid.app/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract.
> Authenticate with the header Authorization: Bearer <token>; public storefront read endpoints require no auth.
> To sign a new merchant up for Fluid programmatically, run `fluid signup` from the Fluid CLI, or call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors.
> Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile.
> The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country).
> api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.
> Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other.
> For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces.
> Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings.
> Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties.
> Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables.
> A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation.
> The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations.
> Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check.
> Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times.

# Start a bundle upload

> Starts publishing one of the member's sites as a built static bundle. Rails assigns the bundle id, checks the files against the limits and the content-type allowlist (each route against the files), the access declaration, `schema` and `meta`, records the bundle as uploading for 60 minutes, and asks the sites gateway for signed PUT URLs for the blobs the site does not store yet. Upload each blob to its URL, then publish the bundle. Nothing is served until it is published, and the site's current version keeps serving. A site may have 5 uploads in progress at once, each lasting 60 minutes, so an older upload on another device keeps working; a start finds failed and expired uploads deleted, and a sixth is refused with `409` until one finishes or expires. Published bundles are kept and do not count.

Bearer only: a request on the cookie mount is refused with `403`, so a site's own code cannot publish. It answers `404` until the sites gateway is released to the member's company, and for a site the member may not change. A gateway that cannot prepare the uploads is a `502`; the bundle is then failed, and starting again makes a new one. A `409` also answers a site already at its 5 uploads in progress.




## OpenAPI

````yaml /api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/bundles
openapi: 3.1.0
info:
  title: Fluid Member API v2026-10 — Sites
  description: >
    The authenticated member's own sites: list, create, read, change, delete,
    publish and copy, list a site's versions and restore one, with the files and
    pages that make up each site, and the branch a member makes to try a change
    to a published site. The credential alone determines the member and company;
    a site and a page are identified by their public ids, never by a numeric id.
    A member can read and change only the sites they own. Any other id, and any
    id of a site in another company, returns 404.


    These operations take a bearer only, the site menu, the site removals and
    the share-target search included, except the status, tables and rows
    operations of a site's database (see the `site-database` tag), which a
    site's own script reaches on the cookie mount when the site has declared
    them. On the same-origin cookie mount, a request with a valid member session
    is refused with `403`, with or without an `X-Fluid-Member-Site` header,
    because a script on the company's storefront shares that origin and would
    otherwise act as the visiting member, so no cookie path to them can be kept
    from it; a request with a missing or unusable session is refused with `401`
    first, as on every cookie-mount route. A page that draws the account menu
    holds the member's bearer and sends it itself.


    The draft preview operations show the member's own site as its builder sees
    it before it is published. They answer with a page's HTML or a file's text
    rather than the JSON envelope, and every response of theirs, a refusal
    included, carries the frame's sandbox policy and is `private, no-store` and
    `noindex`. See the `site-preview` tag.


    Every operation returns 404 while member sites are not enabled for the
    member's company (the `MEMBER_SITES` company feature). A credential that is
    refused is still refused with 401 or 403 first, so a refused credential
    never learns whether the feature is enabled.


    **Sandbox test companies.** A sandbox test company is linked to a live

    company. While the test company cannot be reached, because sandbox access

    is turned off for its live company or the live company was deleted, every

    operation refuses a credential for it with `403` and the standard error

    envelope, before the operation runs.
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
  version: 2026-10
servers:
  - url: https://api.fluid.app
    description: Production API server
  - url: https://api.fluid.test
    description: Local development server
security:
  - MemberBearer: []
tags:
  - name: sites
    x-fluid-section: Members
    description: >-
      The signed-in member's own sites, with publishing, copying and optimistic
      locking.
  - name: site-branches
    x-fluid-section: Members
    description: >-
      The branch of one of the member's published sites, a private copy of the
      site that only its owner and company admins can open, with a preview of
      its own, where a change can be tried without touching the site.
  - name: site-bundles
    x-fluid-section: Members
    description: >-
      Publishing one of the member's sites as a built static bundle, uploaded
      straight to Cloud Storage with signed URLs and made the site's current
      version by a pointer switch.
  - name: site-files
    x-fluid-section: Members
    description: >-
      The files of one of the member's sites (layouts, sections, snippets,
      assets, page content, settings and menus), addressed by theme-style path.
  - name: site-shares
    x-fluid-section: Members
    description: >-
      Who one of the member's sites is shared with, a named member, the member's
      downline or a segment of the company's members, each with a view or copy
      permission.
  - name: site-pages
    x-fluid-section: Members
    description: >-
      The pages of one of the member's sites, each with the template that holds
      its content.
  - name: site-preview
    x-fluid-section: Members
    description: >-
      The draft of one of the member's own sites, rendered as it will be served
      once published, for the builder's own tools.
  - name: site-menu
    x-fluid-section: Members
    description: >-
      The member's account menu, grouped into the company's sites, the sites
      they built, the sites shared with them and the sites they removed.
  - name: site-removals
    x-fluid-section: Members
    description: >-
      Taking a site out of the member's own account menu, and putting it back. A
      removal changes nothing for the site's owner or for anyone else.
  - name: site-pins
    x-fluid-section: Members
    description: >-
      Pinning sites to the member's own account menu, in an order the member
      chooses. A pin changes nothing for the site's owner or for anyone else.
  - name: site-home
    x-fluid-section: Members
    description: >-
      The site the member chooses as their home, the one their account opens on.
      A home changes nothing for the site's owner or for anyone else.
  - name: site-share-targets
    x-fluid-section: Members
    description: >-
      Whom the member may share a site with, inside the reach their company's
      messaging policy gives them.
  - name: site-database
    x-fluid-section: Members
    description: >-
      The database of one of the member's sites, read and written through the
      site's own backend with six fixed operations. The status, tables and rows
      operations are served to the owner's bearer and, on the cookie mount, to a
      site that sends its own `X-Fluid-Member-Site` label and has published a
      declaration naming `database: read` or `database: write`; the SQL
      statement operation is bearer only.
paths:
  /api/member/v2026-10/sites/{site_id}/bundles:
    parameters:
      - $ref: '#/components/parameters/SiteIdPath'
    post:
      tags:
        - site-bundles
      summary: Start a bundle upload
      description: >
        Starts publishing one of the member's sites as a built static bundle.
        Rails assigns the bundle id, checks the files against the limits and the
        content-type allowlist (each route against the files), the access
        declaration, `schema` and `meta`, records the bundle as uploading for 60
        minutes, and asks the sites gateway for signed PUT URLs for the blobs
        the site does not store yet. Upload each blob to its URL, then publish
        the bundle. Nothing is served until it is published, and the site's
        current version keeps serving. A site may have 5 uploads in progress at
        once, each lasting 60 minutes, so an older upload on another device
        keeps working; a start finds failed and expired uploads deleted, and a
        sixth is refused with `409` until one finishes or expires. Published
        bundles are kept and do not count.


        Bearer only: a request on the cookie mount is refused with `403`, so a
        site's own code cannot publish. It answers `404` until the sites gateway
        is released to the member's company, and for a site the member may not
        change. A gateway that cannot prepare the uploads is a `502`; the bundle
        is then failed, and starting again makes a new one. A `409` also answers
        a site already at its 5 uploads in progress.
      operationId: member_sites_bundles_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteBundleStart'
            example:
              files:
                /index.html:
                  sha256: >-
                    aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
                  size: 1832
                  contentType: text/html; charset=utf-8
                /assets/app-3f2a9c.js:
                  sha256: >-
                    bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
                  size: 48211
                  contentType: text/javascript; charset=utf-8
                  immutable: true
      responses:
        '201':
          description: The bundle, and the uploads it still needs.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteBundleStartedEnvelope'
              example:
                status: 201
                data:
                  bundle: 0199537f-0000-7000-8000-000000000004
                  uploads:
                    - sha256: >-
                        bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
                      crc32c: n03x6A==
                      url: >-
                        https://storage.googleapis.com/fluid-production-member-sites/sites/0199537f-0000-7000-8000-000000000001/blobs/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Expires=3600&X-Goog-Signature=5f1e
                      headers:
                        content-type: application/octet-stream
                        x-goog-hash: crc32c=n03x6A==
                  expiresAt: '2026-11-05T11:00:00.000Z'
                meta:
                  request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e
                  timestamp: '2026-11-05T10:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BundleRefused'
        '404':
          $ref: '#/components/responses/BundleNotFound'
        '409':
          $ref: '#/components/responses/BundleConflict'
        '422':
          description: >-
            The request fails its contract, and nothing was started.
            `details.error` names the problem and `details.path` the value that
            has it. `reserved_path` is a path under `/_fluid/`, `invalid_path` a
            path that is not absolute and normalised, `content_type_not_allowed`
            and `content_type_mismatch` a file outside the allowlist or with the
            wrong type, `unknown_file` a route, or the default `/index.html`
            route of a request with no `routes`, to a file the request lacks,
            `functions_not_available` a request that lists server functions,
            `unknown_field`, `unknown_family`, `session_not_declarable` and
            `repeated_entry` an entry of the `access` declaration that is not a
            member field or scope the site may declare, names the `session`
            family, or is listed twice, `out_of_range` a limit exceeded (2,000
            files, 25 MiB a file, 250 MiB a bundle), and `invalid_shape` or
            `invalid_format` a field of the wrong kind or form, including a
            `schema` or `meta` that breaks its contract (`details.path` starts
            at `schema` or `meta`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '502':
          description: >-
            The sites gateway could not prepare the uploads, because it was
            unreachable, timed out or answered with something unexpected.
            `details.error` names which. The bundle is failed; start again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  parameters:
    SiteIdPath:
      name: site_id
      in: path
      required: true
      description: Public id of one of the member's sites.
      schema:
        type: string
        format: uuid
  schemas:
    SiteBundleStart:
      type: object
      description: >-
        The build output's files and metadata. `db/schema.json` and every
        `config/*.json` are bundle metadata, never served as files, so they are
        sent as `schema`, `routes`, `access` and `meta` and never in `files`.
      additionalProperties: false
      required:
        - files
      properties:
        files:
          type: object
          description: >-
            Every servable file, by absolute bundle path with `/` separators, no
            `.` or `..` segment and none under `/_fluid/`. At most 2,000 files,
            25 MiB each and 250 MiB in all.
          additionalProperties:
            $ref: '#/components/schemas/SiteBundleFile'
        routes:
          type: array
          description: >-
            From `config/routes.json`. Omitted, every path is answered by
            `/index.html`, as a single-page app is, so a bundle with no
            `/index.html` must send `routes` of its own (`[]` for none). Each
            route's `file` must be a file of the request.
          items:
            $ref: '#/components/schemas/SiteBundleRoute'
        schema:
          type: object
          description: >-
            The site's `db/schema.json`, checked when the bundle starts against
            the contract's JSON Schema: a table and column limit, names, types,
            defaults and rules. Rules that need more than a schema, such as a
            real calendar day or a column an index names, are checked when the
            bundle is published.
          required:
            - version
            - tables
          properties:
            version:
              const: 1
            tables:
              type: object
            migrations:
              type: array
              items:
                type: object
        access:
          $ref: '#/components/schemas/SiteBundleAccessDeclaration'
        meta:
          type: object
          description: >-
            The site's `config/meta.json`, the title and preview of each page.
            Checked when the bundle starts: a title of at most 200 characters, a
            description of at most 500, an `https` image, and no page under
            `/_fluid/`.
          required:
            - default
          properties:
            default:
              type: object
            pages:
              type: object
        functions:
          type: object
          description: >-
            After V1. Each server function's built module and its
            `config/functions.json` entry. Functions are not available yet, so a
            request that lists any is refused with `functions_not_available`,
            and `{}` is none.
    SiteBundleStartedEnvelope:
      type: object
      description: The bundle that was started.
      properties:
        status:
          type: integer
          description: HTTP status code (mirrors the response status line).
        data:
          $ref: '#/components/schemas/SiteBundleStarted'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - status
        - data
        - meta
    ErrorEnvelope:
      type: object
      description: Standard error envelope.
      properties:
        status:
          type: integer
          description: HTTP status code (mirrors the response status line).
        error:
          type: object
          description: The error message and field-keyed details.
          properties:
            message:
              type: string
              description: Human-readable error message.
            details:
              type: object
              description: >-
                Machine-readable details, keyed by field where a field is at
                fault.
              additionalProperties: true
          required:
            - message
            - details
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - status
        - error
        - meta
    SiteBundleFile:
      type: object
      description: One file of a bundle. The blob is stored once, by its SHA-256.
      additionalProperties: false
      required:
        - sha256
        - size
        - contentType
      properties:
        sha256:
          type: string
          pattern: ^[0-9a-f]{64}$
          description: The SHA-256 of the file's bytes, as 64 lower-case hex characters.
        size:
          type: integer
          minimum: 0
          maximum: 26214400
          description: The file's size in bytes, at most 25 MiB.
        contentType:
          type: string
          minLength: 1
          description: >-
            The type the file's extension maps to in the allowlist (HTML, CSS,
            JavaScript, JSON, source maps, SVG, PNG, JPEG, GIF, WebP, AVIF, ICO,
            WOFF, WOFF2, TXT, XML, PDF, MP4, WebM and MP3). A file outside the
            allowlist, or with another type than its extension's, is refused.
        immutable:
          type: boolean
          description: >-
            True when the file name carries a content hash, so a public site's
            visitors keep it for a year.
    SiteBundleRoute:
      description: >-
        One route of the site's `config/routes.json`. Its `file` is a file of
        the request.
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - path
            - file
          properties:
            path:
              type: string
              pattern: ^/
              description: The one path the route answers.
            file:
              type: string
              pattern: ^/
              description: The file it serves.
        - type: object
          additionalProperties: false
          required:
            - prefix
            - file
          properties:
            prefix:
              type: string
              pattern: ^/
              description: Every path under this prefix is answered by the route.
            file:
              type: string
              pattern: ^/
              description: The file it serves.
    SiteBundleAccessDeclaration:
      type: object
      description: >-
        The site's `config/access.json`, the Fluid data the site uses, in the
        format `MemberSites::AccessDeclaration` validates. It is checked when
        the bundle starts.
      additionalProperties: false
      required:
        - uses
      properties:
        uses:
          type: array
          description: >-
            Each entry is a member field, `member.<field>`, or a scope,
            `<family>: read` or `<family>: write`, for a family a site may
            declare. The `session` family is never declared, and no entry is
            listed twice.
          maxItems: 64
          uniqueItems: true
          items:
            $ref: '#/components/schemas/SiteBundleAccessEntry'
    SiteBundleStarted:
      type: object
      description: The bundle that was started, and the uploads it still needs.
      additionalProperties: false
      required:
        - bundle
        - uploads
        - expiresAt
      properties:
        bundle:
          type: string
          format: uuid
          description: The bundle's id, assigned when the upload starts.
        uploads:
          type: array
          description: >-
            A signed PUT for each blob the site does not store yet. Blobs are
            content-addressed, so an unchanged file is never uploaded twice.
            Empty when every blob is stored already.
          items:
            $ref: '#/components/schemas/SiteBundleUpload'
        expiresAt:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$
          description: >-
            An unfinished upload expires 60 minutes after it starts, as an ISO
            8601 instant in UTC.
    ResponseMeta:
      type: object
      description: Envelope metadata present on every response.
      properties:
        request_uuid:
          type: string
          format: uuid
          description: Server-generated UUIDv7 uniquely identifying this response.
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp at which the server produced the response.
      required:
        - request_uuid
        - timestamp
      additionalProperties: true
    SiteBundleAccessEntry:
      description: A member field as `member.<field>`, or a scope.
      oneOf:
        - type: string
          enum:
            - member.first_name
            - member.last_name
            - member.full_name
            - member.email
            - member.status
            - member.avatar_url
            - member.bio
            - member.language_iso
            - member.member_type
            - member.rank
        - $ref: '#/components/schemas/SiteBundleScope'
    SiteBundleUpload:
      type: object
      description: >-
        One signed PUT for a blob the site does not store yet. Send the blob's
        bytes to `url` with exactly these headers; `x-goog-hash` pins the
        CRC32C, so Cloud Storage refuses different bytes.
      additionalProperties: false
      required:
        - sha256
        - crc32c
        - url
        - headers
      properties:
        sha256:
          type: string
          pattern: ^[0-9a-f]{64}$
          description: The SHA-256 of the blob to upload.
        crc32c:
          type: string
          pattern: ^[A-Za-z0-9+/]{6}==$
          description: >-
            Base64 of the blob's 4-byte CRC32C, as Cloud Storage's `x-goog-hash`
            carries it.
        url:
          type: string
          pattern: ^https://\S+$
          description: The signed URL to PUT the blob to.
        headers:
          type: object
          description: The headers the PUT must send exactly.
          additionalProperties:
            type: string
    SiteBundleScope:
      type: string
      description: >-
        `"<family>: read"` or `"<family>: write"`, for a family a site may
        declare. `session` is not one of them: it is granted with any other
        scope and never named.
      pattern: >-
        ^(addresses|agreements|ai|calendar|carts|contacts|database|media|messages|mysite|notifications|orders|plan|points|profile|search|shares|stats|subscriptions|tasks|widgets):
        (read|write)$
  responses:
    Unauthorized:
      description: Missing or unusable member credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BundleRefused:
      description: >-
        The valid member credential is read-only (a member JWT, or a portal JWT
        minted read-only); the credential belongs to a sandbox test company that
        cannot be reached now; or the request is on the cookie mount, which
        never serves a site's bundles, with or without the `X-Fluid-Member-Site`
        header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BundleNotFound:
      description: >-
        No site of the member's has this id, the member may not change it, or
        the sites gateway is not released to the member's company. One answer
        for each, so it never says whether a site exists.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    BundleConflict:
      description: >-
        The site already has 5 uploads in progress (`details.error` is
        `uploads_in_progress`), so nothing was saved and the gateway was not
        asked; finish one or wait for one to expire, 60 minutes after it
        started. Or the bundle was gone when the gateway answered, because its
        site was deleted (`superseded`), and no upload URLs are returned.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            uploads-in-progress:
              summary: The site's fifth upload is still in progress
              value:
                status: 409
                error:
                  message: >-
                    This site already has 5 uploads in progress; finish or wait
                    for one to expire
                  details:
                    error: uploads_in_progress
                meta:
                  request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e
                  timestamp: '2026-11-05T10:00:00Z'
            superseded:
              summary: The bundle was gone when the gateway answered
              value:
                status: 409
                error:
                  message: This upload is gone, so it cannot be published
                  details:
                    error: superseded
                meta:
                  request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e
                  timestamp: '2026-11-05T10:00:00Z'
  securitySchemes:
    MemberBearer:
      type: http
      scheme: bearer
      description: |
        A member credential in the `Authorization: Bearer` header: a member
        session JWT, a portal JWT whose login is linked to a membership in
        that company, an opaque member token, or a verified One Auth identity
        access token. The credential alone identifies the member and company.
        Member session JWTs, and portal JWTs the server minted read-only, are
        refused with 403 on every write.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.