> ## 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.

# Databases in Mist

> Browse and query your company's reporting databases, your Mist apps' databases and your own Postgres databases in Mist, read-only.

Mist can show and query three kinds of database:

* **Reporting databases**: your company's Fluid data, such as orders, customers and products, plus data from Fluid Connect connectors. An admin turns these on in the admin.
* **Mist app databases**: the database behind each Mist app you build.
* **Your own Postgres databases**: any Postgres database you connect.

Every database session in Mist is read-only. You and Mist can look at data, but not change it.

## Before you start

* **Reporting databases** appear only after an admin turns them on, on the [Databases](/help/admin/settings/databases) screen in the admin. Your role must also be one of the roles listed there under **Who has access**.
* To see a Mist app's production database, your role needs the same reporting-database access.

<Warning>
  Database contents can include personal and financial data. Queries and results may be processed by AI model providers when you ask Mist about them. Read the risk notice on the [Databases](/help/admin/settings/databases) screen.
</Warning>

## Open a database

In the sidebar, open the **Code** group and find **Databases**. Click a database to open the database viewer.

The viewer has two tabs:

* **Browse**: the tables in the database. Type in **Filter tables…** to find one, then click it to see its rows.
* **SQL**: write and run your own query.

For a Mist app's database, a **Local** and **Production** switch picks which copy you see. It starts on **Local** when the app is on your computer. **Local** is the app's database on your computer. **Production** is the live app's database.

## Ask Mist about your data

In the chat, ask a question in plain words, such as "Which 10 products sold the most last month?". Mist writes the query, runs it and shows the answer in the chat. Click **Open in SQL editor** to see and change the query Mist wrote.

To build a live dashboard from your data, type `/dashboard`. See [Slash commands](/help/mist/slash-commands).

<Note>
  When Mist queries a Mist app's database for you, it uses the production database unless you ask for the local one.
</Note>

## Run your own query

<Steps>
  <Step title="Open the SQL tab">
    Open the database, then click **SQL**.
  </Step>

  <Step title="Write the query">
    Write a query that reads data, such as a `SELECT`.
  </Step>

  <Step title="Run it">
    Click **Run**, or press Cmd+Enter (Ctrl+Enter on Windows).
  </Step>
</Steps>

To keep a query, click **Save**. Your queries are under **Saved queries**, on this computer. To download the results, click **Export result to CSV**.

## Connect your own Postgres database

<Steps>
  <Step title="Open the dialog">
    In the **Code** group, click **+** next to **Databases**. The **Add Database Connection** dialog opens.
  </Step>

  <Step title="Enter the details">
    Enter a **Name**, then the **Host**, **Port**, **Database**, **User** and **Password**. Turn on **Require SSL** if your database needs it.
  </Step>

  <Step title="Save it">
    Click **Add Connection**.
  </Step>
</Steps>

Mist stores the password encrypted in your computer's keychain. To copy the connection details later, right-click the database and click **Copy connection string**.

## Limits

* Only read-only queries run: `SELECT`, `EXPLAIN` and `SHOW`. Any other query is rejected with **Only read-only queries are allowed**.
* A query stops after 60 seconds.
* On a production database, avoid slow, expensive queries. They run against the live database.

## Frequently asked questions

<AccordionGroup>
  <Accordion title="Why don't I see my company's Fluid data?" id="no-fluid-data">
    An admin has to turn on the Fluid database on the [Databases](/help/admin/settings/databases) screen, and your role has to be one that can query reporting databases. Ask an admin to check **Who has access** on that screen.
  </Accordion>

  <Accordion title="Why did a Mist app's production database disconnect on my other computer?" id="credential-revoked">
    Mist gets you a personal sign-in for a Mist app's production database. Each time Mist gets a new one, the previous one stops working, on every computer. When the sign-in on one computer stops working, Mist gets a new one the next time it connects there, which ends the sign-in on your other computer.
  </Accordion>

  <Accordion title="Can I talk with Mist by voice about a database?" id="voice">
    No. Voice conversations need a project folder on your computer, and databases don't have one. You can still dictate a message. See [Voice](/help/mist/voice).
  </Accordion>
</AccordionGroup>

## Related pages

* [Databases in the admin](/help/admin/settings/databases)
* [Mist Apps](/help/mist/mist-apps)
* [Model selection](/help/mist/models)


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