> ## 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.
> 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 (send the built folder's 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; the MCP server has no tools for logs, traffic, env vars or converting to an App, so use the fluid sites CLI for those.
> 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.

# SEO and indexing for Sites

> Set a Site's title, description and share image, see which source wins on each page, add head tags, prerendered routes, sitemap.xml and llms.txt at build time with fluidSite(), and turn indexing on.

A Site's title, description and share image come from its SEO settings, set in the Fluid admin, in Mist or with the API. `config/meta.json` in your code overrides them only on the pages it names. Search engines don't index a Site until someone turns indexing on in its SEO settings.

## Where to set a Site's SEO

| Where | What you set |
| - | - |
| The Fluid admin | On a company Site's screen, the **Storefront** card: **Search engine title**, **Search engine description** and **Show in search engines**. See [Sites in the admin](https://docs.fluid.app/help/admin/member-sites.md) |
| Mist | The Site's settings rail, **Search engines**: **Show in search engines**, the title, the description and a share image link |
| The API | `search_engine_optimizer_attributes` on [Update a company site](https://docs.fluid.app/api-reference/sites/update-a-site.md). See [Set SEO](https://docs.fluid.app/storefront/seo.md#set-seo) |

These settings exist for company Sites, which are storefront resources. A member's own Site has no SEO settings and is never indexed.

## Which value wins

The storefront writes the head of each page around your Site: the `<title>`, the meta description, the Open Graph and Twitter tags and the canonical link. Crawlers and link previews read these, never your Site's frame. Each field comes from the first source that has one:

1. `config/meta.json` `routeMeta`, then `pages`, for the page's exact path. This is your code's per-page override.
2. The Site's SEO settings, from the admin, Mist or the API.
3. `config/meta.json` `default`.
4. The Site's own title, description and image, then your store's defaults.

So what someone sets in the admin shows on every page your code doesn't name, even when `config/meta.json` has a `default`. To make the code win on a page, name that page in `routeMeta` or `pages`. To let the SEO settings decide everywhere, leave `config/meta.json` as `{}`, as the template does.

The canonical link is the Site's `/home/sites/<handle>` address on your store, followed by the page's path, such as `https://yoli.com/home/sites/diamond-leaders/events`.

## The page metadata file

`config/meta.json` holds your code's page metadata. Every member is optional, so `{}` is a valid file.

```json config/meta.json theme={null}
{
  "default": {
    "title": "Diamond Leaders",
    "description": "Events and training for the Diamond Leaders team.",
    "image": "/og.png"
  },
  "url": "https://yoli.com/home/sites/diamond-leaders",
  "twitter": { "site": "@yoli" },
  "routes": ["/events", "/drafts"],
  "routeMeta": {
    "/events": { "title": "Events", "description": "Team calls and launches this month." },
    "/drafts": { "noindex": true }
  }
}
```

| Member | What it holds |
| - | - |
| `default` | `title`, `description` and `image` for pages the code doesn't name |
| `pages` | `title`, `description` and `image` by exact path |
| `routes` | The paths to prerender and list in `sitemap.xml` and `llms.txt`, at most 500 |
| `routeMeta` | By exact path: `title`, `description`, `image` and `noindex` |
| `url` | The Site's public `https://` address, with no query or fragment. The build needs it to write `sitemap.xml` |
| `twitter` | `card` (`summary` or `summary_large_image`), `site` and `creator`, each an `@` handle |

A title is 1 to 200 characters and a description at most 500. An image is a file of your build, such as `/og.png`, or an `https://` address with no credential in its query.

`fluid sites lint` warns a company Site that has no title or description in `config/meta.json`, or no routes and no prerender entry. The first warning is fine when the Site's SEO settings set the title and description.

## Add SEO at build time with fluidSite()

A Site is usually a single-page app, so a crawler that doesn't run JavaScript sees an empty page. `fluidSite()` from `@fluid-app/sites/vite` runs after `vite build` and writes what crawlers read. The template already has it:

```ts vite.config.ts theme={null}
import react from "@vitejs/plugin-react";
import { fluidSite } from "@fluid-app/sites/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [react(), fluidSite()],
});
```

It writes into the build:

* **Head tags** in `index.html`: the title, description, Open Graph tags and Twitter card. A title from `config/meta.json` replaces the page's `<title>`. With no title, the page keeps its own.
* **One `index.html` per route**, such as `events/index.html`, with that route's own tags. Routes come from `routes`, plus any plain `path: "/…"` literal in `src/router.ts` or `src/routes.ts`. The Site serves a route's own file before the single-page app fallback.
* **Page content.** With the `prerender` option, a module that exports `render(path)`, each page's HTML goes inside the root element. Without it, each page gets a `<noscript>` with its title and description.
* **`llms.txt`**, listing the home page and every route.
* **`sitemap.xml`**, only when `config/meta.json` has an absolute `url`. A sitemap needs absolute addresses.

A route that `routeMeta` marks `noindex` gets `<meta name="robots" content="noindex">` and is left out of `sitemap.xml` and `llms.txt`. A `config/meta.json` that breaks these rules fails the build, naming the field. At build time a route's tags come from `routeMeta`, then `pages`, then `default`. On the storefront, the SEO settings sit between `pages` and `default`, as above.

## Indexing

Search engines may index a Site only when all of these hold:

* it's a company Site, not a member's Site and not a branch;
* it's public, switched on, not taken down, and published;
* indexing is turned on in its SEO settings: **Show in search engines** in the admin or Mist, or `indexable: true` with the API;
* your store doesn't block indexing for the whole storefront.

Indexing is off for every new Site until someone turns it on. `config/meta.json` can't turn it on.

What the Site's host sends:

* **`X-Robots-Tag: noindex, nofollow`** on every answer of a Site that isn't indexable.
* **`robots.txt`.** For a Site that isn't indexable, one that disallows everything, whatever the build ships. For an indexable Site, the build's own `robots.txt`, or on its [standalone host](https://docs.fluid.app/sites/standalone-hosting.md) a generated one that allows everything and names the sitemap.
* **`sitemap.xml` and `llms.txt`.** None for a Site that isn't indexable: they answer not found. For an indexable Site, the build's own files, or on its standalone host files generated from `routes` in `config/meta.json`.
* **A canonical `Link` header** on each page of a standalone Site, naming the page's storefront address. For a company with no storefront, the standalone address is the canonical one.

Your store's `sitemap-sites.xml` lists its live company Sites. See [SEO and the page head](https://docs.fluid.app/storefront/sites.md#seo-and-the-page-head).


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