> ## 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, 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 quickstart

> Create a Mist app, describe what it should do, run it on your computer and publish it, from the Mist desktop app or the Fluid CLI.

This page takes you from nothing to a live Mist app. Pick the Mist desktop app if you'd rather chat than type commands. Pick the Fluid CLI if you work in a terminal.

## Before you start

* Your role needs the **Mist** permission that starts with **Create new Mist hostings**. See [Roles](/help/admin/settings/roles). Through the API, that's the `mist.create` permission.
* Your company needs usage credits if Fluid draws your hosting from credits. See [Billing](/mist-apps/billing).

## Build with the Mist desktop app

<Steps>
  <Step title="Create the app">
    In the **Code** group of the sidebar, click **+** next to **Mist Apps**, or press Cmd+Shift+M. Enter a name, such as "Event attendance", and click **Create Mist**.

    You see **Setting up your Mist Cloud environment…** while Fluid creates the repository, server and database.
  </Step>

  <Step title="Describe what you want">
    In the chat, describe the app in plain words. For example: "Build a page where reps log who came to their event, and save each entry to the database."

    Mist writes the code in the app's repository on your computer.
  </Step>

  <Step title="Run it locally">
    In the preview toolbar, click **Run**. The app runs on your computer with its own local database, so your tests don't touch production data.
  </Step>

  <Step title="Publish">
    Click **Publish**. Mist pushes your changes to the app's repository, and Fluid builds and deploys them. The status shows **Live** when it's done.
  </Step>
</Steps>

For every button and message along the way, see [Mist Apps](/help/mist/mist-apps) and [Run and publish](/help/mist/run-and-publish) in the Help Center.

## Build with the Fluid CLI

<Steps>
  <Step title="Install and sign in">
    ```bash theme={null}
    npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-mist
    fluid login
    ```
  </Step>

  <Step title="Create the app">
    ```bash theme={null}
    fluid mist create --name "Event attendance"
    ```

    Creating an app takes about a minute. The command prints the app's slug, such as `3bed85`, and the command to clone it.
  </Step>

  <Step title="Clone the repository">
    ```bash theme={null}
    fluid mist clone 3bed85 --dir event-attendance
    cd event-attendance
    ```

    Without `--dir`, the CLI clones into a folder named after the app. It also writes a `.mist` file there, so later `fluid mist` commands in that folder don't need the slug.
  </Step>

  <Step title="Run it locally">
    ```bash theme={null}
    npm install
    npm run dev
    ```

    Open `http://localhost:3000`. The app uses a local database file, so you don't need Postgres installed.
  </Step>

  <Step title="Publish">
    ```bash theme={null}
    fluid mist push --watch -m "Add event attendance log"
    ```

    `push` commits your changes and pushes them to the app's repository, which starts a deployment. `--watch` follows the build until it's ready or fails.
  </Step>

  <Step title="Open the live app">
    ```bash theme={null}
    fluid mist open
    ```
  </Step>
</Steps>

To see every `fluid mist` command and its flags, run `fluid mist --help`.

## Create from the admin

You can also create a Mist app on the [Mist Apps](/help/admin/settings/mist-apps) screen in the admin. Click **Create Mist**, enter a **Name** and click **Create**. Then open the app in Mist or clone it with the CLI to build it.

## Create through the API

Send a request to [Provision a new Mist](/api-reference/mists/provision-a-new-mist) with a company admin Bearer token. The response returns the app in the `provisioning` state with its final public address. Poll [Show one Mist](/api-reference/mists/show-one-mist) until the state is `live`.

## Next steps

* [Add an integration point](/mist-apps/integration-points) to put the app inside Fluid.
* [Add your own environment variables](/mist-apps/hosting#add-your-own-environment-variables), such as an API key.
* [Connect a custom domain](/mist-apps/domains).


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