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

# Publish a member site

> Check a member site's build and declarations with fluid sites lint, publish it with fluid sites publish, and read what each answer means.

You publish a member site with the Fluid CLI. `fluid sites publish` uploads your build output and declarations, and makes them the site's current version in one step. Until that step succeeds, the site keeps serving its current version.

## Before you start

Install the Fluid CLI and its member site plugin, and sign in:

```bash theme={null}
npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-member-site
fluid login
```

Your login follows the site's owner. A member's site is published with that member's login, and a company site with the login of an admin who may change themes. Say which one you're using with `--as member` or `--as admin`. Without it, the server decides and a refusal names the login the site needs.

`fluid sites publish` needs the folder's binding file, `.member-site.json`, which names the site. To start a new site, run `fluid sites create` in your site's folder. It creates the site and writes the binding there, and leaves your files alone:

```bash theme={null}
fluid sites create diamond-leaders --name "Diamond Leaders" --as member
```

For a company site, add `--company` and use `--as admin`. A folder already bound to the same site is left as it is, and a folder bound to another site is refused.

## Check the site

`fluid sites lint` checks the site's folder on your machine. It makes no request and needs no login.

```bash theme={null}
npm run build
fluid sites lint
```

It runs the same checks `fluid sites publish` runs before it sends anything:

* Every file of the build has a type a site may serve, such as HTML, CSS, JavaScript, JSON, SVG, images, fonts, text, XML, PDF, MP4, WebM and MP3.
* No file is under `/_fluid/`, and nothing in the build is a symbolic link.
* The build holds at most 2,000 files, each at most 25 MiB, and 250 MiB in all.
* The build has an `index.html` when there's no `config/routes.json`, and every route names a file of the build.
* `db/schema.json`, `config/access.json`, `config/meta.json` and `config/routes.json` are valid JSON and pass their rules.
* There's no `functions/` folder or `config/functions.json`. Server functions aren't available yet.

Each problem is an error that names its file. A clean folder prints nothing and exits `0`. Any error exits `1`.

The build's folder is `dist` by default. Name another with `--dir`, relative to the site's folder:

```bash theme={null}
fluid sites lint ./diamond-leaders --dir build
```

## Publish

```bash theme={null}
fluid sites publish
fluid sites publish ./diamond-leaders --dir build --as member
```

The command:

1. Hashes every file of the build. A file under `assets/` whose name carries a content hash, such as `index-Bx3zQw9a.js`, is cached by browsers for a year.
2. Reads `db/schema.json` and the files in `config/`.
3. Runs the checks of `fluid sites lint`, and stops before any request when one fails.
4. Uploads only the files the site doesn't store yet. Publishing the same build twice uploads nothing the second time, and changing one file uploads one file.
5. Publishes: applies the schema and makes the new build the site's current version.

A new site is private until its owner makes it public. Publish it, open it at its storefront address, and check it before you share it.

To go back to an earlier build, see [Make an earlier bundle current](https://docs.fluid.app/api-reference/site-bundles/make-an-earlier-bundle-current-roll-back.md). The other operations behind publishing are [Start a bundle upload](https://docs.fluid.app/api-reference/site-bundles/start-a-bundle-upload.md) and [Publish a bundle](https://docs.fluid.app/api-reference/site-bundles/publish-a-bundle.md), or for a company site [Publish a company site's bundle](https://docs.fluid.app/api-reference/member-site-bundles/publish-a-company-sites-bundle.md).

### Confirm a destructive schema change

A change to `db/schema.json` that drops, renames or retypes a table or column, or makes a column required, needs a migration. Confirm each migration by its id, once per migration:

```bash theme={null}
fluid sites publish --confirm 2026-11-20-rsvp-party-size
```

Without it, the publish is refused with `destructive_change_unconfirmed`, the command lists each unconfirmed migration with its steps, and nothing changes. See [Change the schema](https://docs.fluid.app/member-sites-v1/database.md#change-the-schema).

## What the answers mean

| Answer | What it means | What to do |
| - | - | - |
| `404` on the start | The site wasn't found for this login, or member sites aren't on for your company. Both answer the same `404` | Check the folder's `.member-site.json` and your login. If they're right, ask Fluid to turn member sites on |
| `409` `uploads_in_progress` | The site has 5 uploads in progress | Run it again once one finishes or expires, 60 minutes after it started |
| `409` on the publish | The bundle can no longer be published. Nothing changed | Run the command again for a new bundle |
| `422` | A check failed. The command names it and where, or the files that weren't stored. Nothing was published | Fix it and publish again |
| `no_database` | The site has a `db/schema.json`, and site databases aren't on for your company yet. Nothing was published | Publish without the `db/` folder for now, or wait until databases reach your company |
| `409` `schema_change_pending` | An earlier publish's schema change timed out and may have run. Nothing changed | Publish the version the answer names (`details.pendingBundle`) again. That finishes the change |
| `422` `destructive_change_unconfirmed` | The schema has a destructive change you didn't confirm | Run it again with `--confirm` for each migration listed |
| `502` | Fluid couldn't finish a step, and the bundle failed | Run it again |
| `504` `publish_timeout` | The publish ran out of time. The current version keeps serving | Nothing: the command sends it again, up to three times. After that, run the same command again. It's safe, and uploads no file again |
| `504` with no code | A proxy timed out, so the outcome is unknown and the build may still go live | Wait a minute, check what the site shows, then run it again without rebuilding |

The command never prints the upload addresses it uses.


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