> ## 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. # Download Mist > Download and install the Mist desktop app on macOS or Windows, sign in with your Fluid account, and keep the app up to date. Mist is a desktop app called **Fluid Mist**. Fluid publishes builds for: * macOS on Apple silicon * macOS on Intel * Windows ## Download the app In the admin, click the **Developer Hub** code icon in the top bar. You can also click the **Settings** gear, then select **Developer** under **System**. Click the **Meet Mist Desktop** banner. Its button reads **Download for** and the name of your computer's system, such as **Download for macOS (Apple Silicon)** or **Download for Windows**. Your browser downloads the latest build for your computer. To open the Developer Hub or the **Developer** screen, your role needs at least **View only** for **Developer**, in the **Settings** card on the role's **Permissions** tab. See [Roles](/help/admin/settings/roles). The banner assumes a Mac has Apple silicon when the browser can't tell. On an Intel Mac, click **Intel Mac? Get the x64 build** under the banner. It opens the release page, where you download the file that ends in `x64.dmg`. If the banner can't find a build for your computer, it opens the latest release page instead. Download the file for your system from there: | Your computer | File to download | | - | - | | Mac with Apple silicon | The file ending in `arm64.dmg` | | Mac with an Intel processor | The file ending in `x64.dmg` | | Windows | The file ending in `Setup.exe` | ## Install the app 1. Open the `.dmg` file you downloaded. 2. Drag **Fluid Mist** into your **Applications** folder. 3. Open **Fluid Mist** from **Applications**. 1. Run the `Setup.exe` file you downloaded. 2. The installer installs Fluid Mist and opens it. ## Sign in The first time you open Mist, it asks you to sign in. You can't use the app until you do. Under **Log in to your Fluid account**, enter the email address you use for Fluid. Click **Send code**. Fluid emails you a 6-digit code. Enter it, then click **Verify**. If the code doesn't arrive, click **Resend code**. If your account belongs to more than one company, pick the one you want to use first. If it belongs to only one, Mist picks it for you. The code expires after a few minutes. Mist shows how long you have on the code screen. If you see **No companies are associated with that account.**, your email address isn't on any Fluid company. Ask an admin at your company to add you. ### Switch company Click the company name in the title bar. Search for the company, then click it. ### Sign out Click your name at the bottom of the sidebar, then click **Log Out**. Mist asks you to confirm. Projects you downloaded and your chat history stay on your computer. ## Updates Mist updates itself. While it's open, it checks for a new version when it starts and every 10 minutes after that, and downloads it in the background. When an update is ready, the **Fluid Mist Update** message appears: * Click **Restart** to install the update now. * Click **Later** to keep working. The update installs when you quit and reopen Mist. If a workflow is running, you see **Update ready — waiting for workflows to finish** instead. Mist doesn't restart while a workflow runs. The **Restart** and **Later** message comes back when every workflow has finished or been cancelled. On macOS, you can also check by hand. In the menu bar, open the **Fluid Mist** menu and click **Check for Updates…**. You see **You're up to date.** or **Update found — downloading now.** ## Frequently asked questions No. Fluid publishes builds for macOS and Windows only. No. Mist is a desktop app. In the admin, you can manage the apps you build with Mist on [Mist Apps](/help/admin/settings/mist-apps). The code expires after a few minutes. Click **Resend code** to get a new one. Make sure you entered the email address you use for Fluid. ## Get help Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](/help/getting-help) page lists what to include in your request. ## Related pages * [Mist overview](/help/mist) * [Getting around](/help/mist/getting-around) * [Developer](/help/admin/settings/developer) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.