> ## 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. # Mist Apps and other projects > Create Mist apps, themes, portals, widgets, MySites, skills and database connections in Mist, and manage a Mist app's domain, environment variables and integration points. Everything you build in Mist is a project. Projects are listed by type in the **Code** group of the sidebar. ## Project types | Type | What it is | | - | - | | **Mist Apps** | A hosted web app with its own backend and database. Fluid hosts it for you. | | **Themes** | Your storefront theme, built with Liquid. | | **MySites** | A rep's MySite. | | **Portals** | A portal: the signed-in experience for your reps. | | **Widgets** | A component for the portal builder. | | **Skills** | A local skill. See [Skills](/help/mist/skills). | | **Databases** | A connection to a database. See [Databases](/help/mist/databases). | ## Create a project In the **Code** group, hover over a type and click **+**, such as **New Mist**. You can also ask Mist in the chat, for example "Build me an app that lets reps log event attendance". Mist shows an **Approve** and **Dismiss** card before it creates anything. Shortcuts create the most common types: * Cmd+Shift+M: a Mist app * Cmd+Shift+T: a theme * Cmd+Shift+W: a widget * Cmd+Shift+S: a skill On Windows, use Ctrl instead of Cmd. ## Create a Mist app In the **Code** group, click **+** next to **Mist Apps**, or press Cmd+Shift+M. Enter a name under **Name (optional)**, such as "Customer Portal". Click **Create Mist**. You see **Setting up your Mist Cloud environment…** while Fluid sets up the app. Fluid creates a code repository, a database and hosting for the app. The app starts as a Next.js web app. Ask Mist to build what you need, then run it on your computer and publish it. See [Run and publish](/help/mist/run-and-publish). To create a Mist app, your role needs the **Mist** permission that starts with **Create new Mist hostings**. See [Roles](/help/admin/settings/roles). If creating fails, you see **We couldn't finish creating your Mist right now.** This is usually temporary, so try again in a moment. If it keeps happening, contact Fluid support. ## Manage a Mist app Right-click a Mist app in the sidebar for: * **Rename…**: change the app's name. * **Environment variables…**: view and set the app's environment variables, such as API keys. * **Domain**: connect your own domain to the app. See [Connect a domain](#connect-a-domain). * **Compute**: the app's server settings, saved in the app's code. It appears once the app is on your computer. * **Add integration point…**: connect the app to Fluid, as a droplet, a drop zone or a mobile embed. * **Delete…**: delete the app. See [Delete a Mist app](#delete-a-mist-app). You can also see and create your company's Mist apps in the admin, on [Mist Apps](/help/admin/settings/mist-apps). ### Connect a domain Right-click the Mist app and click **Domain**. Under **Add a domain**, enter the domain, such as `shop.example.com`. Add the DNS records Mist shows at your domain provider. The domain shows **Pending verification** or **Needs DNS routing** until the records work, then **Live**. Click **Re-check verification** to check again. To disconnect a domain, click **Remove domain**. ### Delete a Mist app Right-click the Mist app and click **Delete…**. Type the app's name, then click **Delete Mist**. Fluid schedules the app to be torn down in 15 days. Until then, you can still restore it. Mist doesn't have a restore button yet. To restore an app, contact Fluid support. ## Related pages * [Run and publish](/help/mist/run-and-publish) * [Databases](/help/mist/databases) * [Mist Apps in the admin](/help/admin/settings/mist-apps) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.