> ## 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.
> To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, commercetools, WooCommerce, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate.
> Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is /<username>/products/<slug>; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a.
> 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.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy, or inline through the MCP site_deploy tool when it imports nothing. See /sites/functions and /sites/rest-api.
> 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.
> To create a URL redirect, create a custom route on the Sitemap: POST /api/theme_region_rules with redirect_type redirect, a redirect_url, region_code default, route_kind non_credit and redirect_status_code 301 or 302. See /themes/custom-routes#create-a-redirect-with-the-api. Never use /api/redirects; those legacy redirects are no longer used, and the admin's Sitemap screen doesn't show them.
> 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.

# Password-protect a Site

> Put a public Site behind a shared password: who is asked for it, how often, the password rules and error codes, and how the owner or a company admin sets and removes it.

A public Site can ask visitors for a password before it opens. Anyone who has the address and the password can open it, signed in or not. Use it to share a page with people outside your company's member list, such as event guests, without opening it to everyone.

## Who is asked for the password

The Site's owner and company admins aren't asked while they're signed in. Everyone else is, members the Site is shared with included. Until the Sites gateway is on for your company, no one is asked: a public Site with a password opens only for its owner and company admins.

While a password is set, shares don't open this site: people you've shared it with type the password like everyone else and can't edit or copy it. A share grants nothing while the password is set:

* **View:** the holder opens the Site by typing the password, like any visitor.
* **Edit:** the holder can't read or change the Site's drafts or branches. Only the owner and company admins can.
* **Copy:** the holder can't copy the Site.

The Site also leaves members' [sites menu](https://docs.fluid.app/sites/overview.md#show-a-site-to-members). Company admins still see it there.

Remove the password, or make the Site private, and shares work again. A private Site [keeps its password](#private-sites-keep-their-password), so shares stop again once it's public.

## What a visitor sees

In place of the Site, a visitor sees **This site is password protected**, a **Password** field and **Open site**. The page names nothing about the Site, and search engines are asked not to index it.

* **Each page load asks again.** The password opens the Site for that page load only. A reload, a new tab or coming back asks again, and an open page asks again after 8 hours.
* **A wrong password** shows "That password isn't right. Try again." The same message shows when the Site can't be opened at all.
* **Too many tries** shows "Too many tries. Wait a few minutes, then try again."

Changing or removing the password ends every page that's open with the old one.

## Password rules

A Site password has at least 6 characters, at most 72 bytes, and at least one letter, one digit and one symbol. A symbol is any character that isn't a letter or a digit, a space included. Nothing is trimmed, and nothing else is required. A refused password says which rule it broke; see [Errors](#errors).

Only a public Site can be given a password. A branch never can: it's always private.

## Private Sites keep their password

Making a password Site private keeps its password. Making it public again asks visitors for that same password. Only removing the password takes it away.

The API never returns a password. The v2026-10 Member and company APIs show whether a Site has one with two fields on every Site:

| Field | Means |
| - | - |
| `password_protected` | `true` while the Site is public and asks for a password |
| `password_updated_at` | When the password was last set, while the Site keeps one, whatever its visibility. `null` when it has none |

Read `password_updated_at` to know whether a Site has a password, and `password_protected` to know whether visitors are asked for it now. A protected Site's `visibility` is `public`, so in a company's list of Sites, `filter[visibility]=public` returns protected Sites too. Check `password_protected` to tell them apart.

## Set, change or remove the password

The Site's owner, or a company admin, sets the password.

> [!NOTE]
>
> Site passwords need the Sites gateway, which isn't on for every company yet. Until it is, you can remove a password but not set one. To turn it on, [contact support](https://docs.fluid.app/help/getting-help.md).

### In the Fluid admin

Open the Site under **Website** > **Sites** and use its **Password** card, on a company Site or a member's: **Add a password** or **Change password**, type it, then **Save password**. **Remove password** asks you to confirm. The page never keeps the password in its form.

The card also shows when a private Site has kept its password. See [Sites in the admin](https://docs.fluid.app/help/admin/member-sites.md#a-sites-page).

### With the CLI

With Sites plugin 0.1.503 or later, in the Site's folder, with the owner's [login](https://docs.fluid.app/sites/publishing.md#before-you-start):

```bash theme={null}
fluid sites password set
fluid sites password remove
```

`set` asks for the password twice at a prompt that doesn't echo it, and never takes it as an argument. Where there's no terminal, such as in CI, pipe it in:

```bash theme={null}
printf %s "$SITE_PASSWORD" | fluid sites password set --password-stdin
```

`--public` makes a private Site public behind the password in one change, so it's never open without it. `fluid sites visibility` and `fluid deploy --public` keep a Site's password, and a protected Site shows as `public (password)`.

### In Mist

Open the Site's **Settings** and use the **Password** card: **Set password**, or **Change**, type it, then **Save password**. On a private Site, use **Make public and protect**. **Remove** asks you to confirm. Mist never stores, logs or shows the password, and its agent never sees one: it can open the **Password** card for you, but won't set a password itself.

### From an AI client

The Fluid MCP server has `site_password_set` and `site_password_remove` for admins, and `my_site_password_set` and `my_site_password_remove` for your own Sites. See [the tools](https://docs.fluid.app/sites/deploy-from-claude.md#the-tools).

> [!WARNING]
>
> A password you give an AI client passes through its model and stays in the chat. Type it yourself in Mist or with `fluid sites password set` when that matters.

### With the API

As the Site's owner, [change the site](https://docs.fluid.app/api-reference/sites/change-a-site.md) through the Member API:

```bash theme={null}
curl -X PATCH "https://api.fluid.app/api/member/v2026-10/sites/{id}" \
  -H "Authorization: Bearer $MEMBER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "password": "fall-2026!" }'
```

* `{ "password": "..." }` sets or changes the password. `{ "password": null }` removes it.
* `{ "visibility": "public", "password": "..." }` makes a private Site public behind the password in one change.

As a company admin, [change the member site](https://docs.fluid.app/api-reference/member-sites/change-a-member-site) through the company API, with `application_themes.update`:

```bash theme={null}
curl -X PATCH "https://api.fluid.app/api/company/v2026-10/member-sites/{id}" \
  -H "Authorization: Bearer $ADMIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "member_site": { "password": "fall-2026!" } }'
```

Use an admin's own login. A company API token never changes a member's Site, and changes a company Site only where Fluid has turned that on; see [Deploy from CI or an agent](https://docs.fluid.app/sites/quickstart.md#deploy-from-ci-or-an-agent).

## Errors

A refused password change answers `422` in the usual [error shape](https://docs.fluid.app/sites/member-api.md#errors). `error.details.error` names the code, and for a password rule, `error.details.password` holds the message:

```json theme={null}
{
  "status": 422,
  "error": {
    "message": "Password must include a symbol",
    "details": {
      "error": "password_needs_symbol",
      "password": ["Password must include a symbol"]
    }
  },
  "meta": { "request_uuid": "…", "timestamp": "…" }
}
```

| Code | Means |
| - | - |
| `password_too_short` | Under 6 characters |
| `password_too_long` | Over 72 bytes. A character outside plain ASCII, such as `é` or an emoji, takes 2 to 4 bytes |
| `password_needs_letter` | No letter |
| `password_needs_digit` | No digit |
| `password_needs_symbol` | No symbol |
| `password_requires_public` | The change would leave the Site private. Send `"visibility": "public"` with the password |
| `password_not_for_branch` | The Site is a branch, which is always private |
| `password_unavailable` | The Sites gateway isn't on for the company yet |
| `suspended` | The Site is [taken down](https://docs.fluid.app/storefront/sites.md#when-a-site-is-taken-down) and the change would leave it public, by removing its password or making it public behind one. Send `"visibility": "private"` with a removal, or have an admin bring the Site back first |
| `password_has_nul` | From the MCP tools only: the password holds a NUL character. The API refuses one as an invalid parameter |


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