> ## 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. # Run and publish > Run a project on your computer, switch the preview between Local and Prod, read logs, publish your changes, and roll back to an earlier version. You build in two places: * **Local**: the project runs on your computer. Changes you make here aren't live. * **Prod**: production, the live version your customers, reps or users see. You work locally, check the preview, then publish to production. ## Before you start The project must be on your computer. If it isn't, **Run** and **Publish** show **Clone this project locally first**. Open the project and click **Download to this machine** in the preview. ## Run locally In the preview toolbar, click **Run**. The button shows **Starting…**, then **Stop** once the project is running. The preview shows your local version. You can also press Cmd+Shift+Enter, or Ctrl+Shift+Enter on Windows. To stop every running project at once, press Cmd+Shift+K, or Ctrl+Shift+K. Locally, a Mist app uses its own database on your computer, not the production database. Changes you make to data while you test locally don't reach production. ## Switch between Local and Prod The preview header has two tabs, **Local** and **Prod**. Click one to preview that version. For a MySite, **Prod** shows your draft on the production servers, not the published MySite. ## Read the logs Click **Logs** in the preview toolbar. It appears once there's output to show. * **Dev server output** shows what the project prints while it runs locally. * **Publish output** shows what happens during a publish. * For a Mist app, the **Production** tab streams the live app's logs as requests arrive. The **Local** tab shows your computer's output. Lines with errors show in red. Mist keeps the latest 2,000 lines. You can also ask Mist to read the logs for you, for example "Why did my app crash?". Mist checks the logs and the preview console, and tells you what it finds. ## Publish Publishing changes what's live, and Mist doesn't ask you to confirm. Check the **Local** preview first. Run the project locally and check the preview. In the preview toolbar, click **Publish**, or press Cmd+Shift+P (Ctrl+Shift+P on Windows). The button shows **Publishing…** and the logs open. The status shows **Live** when the publish is done, or **Build failed** if it isn't. What **Publish** does depends on the project: | Project | What Publish does | | - | - | | Mist app | Saves your changes, sends them to the app's repository and builds the live app. | | Theme | Pushes your theme files to Fluid. | | Portal | Pushes the portal to Fluid and makes it the active version. | | Widget | Pushes the widget to Fluid. | | MySite | Publishes your changes to the live MySite. | To cancel, hover over **Publishing…** and click **Cancel publish**. For a Mist app, the changes may already have been sent, so the app can still go live. Publishing is blocked while [Safe Mode](/help/mist/safe-mode) is on. ### If a publish fails When a publish fails, Mist tries one fix, then publishes again. You see **Publish failed — Mist is making one fix. Publishing will retry once when the fix is done.** If that also fails, you see **Publish stopped:** with the reason and what to do. Mist won't publish again for the same failure on its own. A bar under the preview offers **Retry**, **Ask Mist** and **Dismiss**. | Reason | What to do | | - | - | | **Validation rejected** | Check the project's settings and fix the issue the logs report. | | **Remote theme changed** | Nothing. Mist merges the changes made elsewhere and publishes again. | | **Merge conflicts to resolve** | Someone changed the same files. Resolve the conflicts, then publish again. Ask Mist to help. | | **Authentication failed** | Sign in to Mist again, then publish again. | | **Network unavailable** | Check your internet connection, then publish again. | | **Publish tooling failed** | Ask Mist to check the project's publish setup before you retry. | | **Publish timed out** | Check your connection, then publish again. | | **Publish cancelled** | Nothing failed. Publish again when you're ready. | ## Roll back **History** in the preview toolbar lists earlier versions of the project's files and publishes. In the preview toolbar, click **History**. Find the version you want and click **Roll back**. Mist saves your current state to a backup first. Then it brings back the older version as a new change. Rolling back changes only your local files. Click **Publish** to make the older version live. To undo changes Mist made to your company through the Fluid API, such as product updates, use [Time Machine](/help/mist/time-machine). ## 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 Apps](/help/mist/mist-apps) * [Time Machine](/help/mist/time-machine) * [Safe Mode](/help/mist/safe-mode) * [Pick an element](/help/mist/pick-an-element) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.