> ## 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 ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, 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. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > 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 where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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 — 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. # Connect AI tools to Fluid > Give Claude, Cursor, VS Code, or another AI agent access to Fluid: the docs MCP server to search and read the docs, the Fluid CLI with an API token to make changes, and Mist. **You can connect an AI agent to Fluid in three ways.** Pick by what the agent needs to do: | Option | What the agent can do | Credentials | | - | - | - | | [Docs MCP server](#docs-mcp-server) | Search and read the Fluid docs and API specs | None | | [Fluid CLI](#fluid-cli) | Make changes to your company: themes, guided setups, and more | Your sign-in, or an API token | | [Mist](#mist) | Build and change things for your company by chatting | Your Fluid sign-in | Most agents use the first two together: the docs MCP server to look up how something works, and the CLI to do it. ## Docs MCP server Fluid's docs come with a hosted, read-only [Model Context Protocol](https://modelcontextprotocol.io) (MCP) server at: ```text theme={null} https://docs.fluid.app/mcp ``` There's nothing to install, and it needs no API token. Connected agents can: * **Search** the docs, guides, and API reference. * **Read** any docs page or OpenAPI spec in full. * **Send feedback** about a docs page that's wrong or missing something. It only reads published documentation. It can't read or change your company's data, and it doesn't accept an API key. ### Connect from a docs page Every docs page has a menu at the top. Use it to copy the MCP server URL or install the server in Cursor or VS Code in one click. ### Connect by hand Run this in any terminal. Claude Code keeps the server in your configuration. ```bash theme={null} claude mcp add --transport http fluid-docs https://docs.fluid.app/mcp ``` Add this to `~/.cursor/mcp.json` for every project, or `.cursor/mcp.json` for one project. Then restart Cursor. ```json theme={null} { "mcpServers": { "fluid-docs": { "url": "https://docs.fluid.app/mcp" } } } ``` VS Code needs the transport type. Add this to `.vscode/mcp.json` in your project, or run **MCP: Open User Configuration** from the Command Palette to add it for every project. ```json theme={null} { "servers": { "fluid-docs": { "type": "http", "url": "https://docs.fluid.app/mcp" } } } ``` Add remote servers in the app, not in `claude_desktop_config.json`. Go to **Settings** → **Connectors** → **Add custom connector**, and paste `https://docs.fluid.app/mcp`. The same setup steps are in the admin, on **Settings** → **Developer**. See [Developer](/help/admin/settings/developer). ### Without MCP Agents that can't use MCP can still read the docs: * [`/llms.txt`](https://docs.fluid.app/llms.txt) indexes every page for language models. * [`/skill.md`](https://docs.fluid.app/skill.md) is a short guide for AI tools: where to look, Fluid's naming, and the main conventions. * Every page can be copied as Markdown from its page menu. ## Fluid CLI To make changes, give the agent the [Fluid CLI](/themes/cli). It works on your company's themes, and its plugins run Fluid's [guided setups](/setup/overview), such as connecting a back office, opening a country, or setting up payments onboarding. Every guided-setup command prints JSON, so an agent can read the result of each step. Sign the CLI in one of two ways: * **Your own sign-in.** Run `fluid login` and enter the code Fluid emails you. Use this when you're at the keyboard with the agent. * **An API token.** Create one at **Settings** → **API Tokens**, then sign in with it. Pass it in an environment variable so it stays out of your shell history: ```bash theme={null} FLUID_TOKEN= fluid login ``` Use this when the agent runs on its own. See [Authentication](/api/authentication) for token types. Run `fluid theme skills install` to give your agent Fluid's theme skills as well. To set up a whole store with an agent, follow the [agent launch guide](/api/agent-launch). The docs MCP server and the CLI are separate. The MCP server never sees your token. ## Mist [Mist](/help/mist) is Fluid's own AI assistant, a desktop app that builds and changes things for your company when you chat with it. You sign in with your Fluid account, so it doesn't need an API token or an MCP setup. The [Mist Skills](/guides/mist-skills) repository has the skills and workflows Mist uses. Many of them also work in other agents, such as Claude Code, outside Mist. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.