> ## 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 confirmation link, then sign the agent in to the Fluid CLI or give it 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # Turn on visitor numbers for a Mist app > Turns on Vercel Web Analytics for the Mist's Vercel project, which is what the traffic read needs before it can return numbers. Page views then count toward the app's hosting usage. Calling it again for an app that is already on answers the same `200`, so it is safe to repeat. The request has no body. Only companies with Mist growth tools turned on can call it. For any other company this endpoint returns `404` and sends nothing to Vercel. A failed request names its reason in `error.code`: - `409` `not_provisioned` when the Mist has no Vercel project yet. - `402` `web_analytics_plan_required` when the Vercel plan does not include Web Analytics. - `502` `web_analytics_forbidden` when Mist's Vercel credential may not change the project. - `502` `vendor_error` for any other Vercel failure. Returns `409` without `error.code` while the Mist is `pending_destroy`. Requires a company admin token with the `mist.create` permission. ## OpenAPI ````yaml /api-reference/mist-v2026-04.yaml post /api/v202604/mists/{mist_id}/traffic/enablement openapi: 3.1.0 info: title: Fluid Mist v2026-04 API version: v2026-04 description: | Mist is Fluid's lite cloud for hosting droplets, drop zones, and app extensions. One API call provisions a GitHub repository, a Postgres database, and a deployment behind a Fluid-hosted subdomain. The Fluid CLI (`fluid mist ...`) is built on this API, and every developer-facing Mist workflow is available through it. All endpoints require a company admin Bearer token with the matching `mist.*` permission. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: mists description: | Provision, list, inspect, rename, delete, and restore Mist apps. Deleting a Mist starts a 15-day grace period during which it can be restored. x-fluid-section: Developers - name: mist_env_vars description: | Read and manage the environment variables on a Mist app's deployment project. Variables that Mist provisions itself are listed but read-only. x-fluid-section: Developers - name: mist_code description: | Read a Mist app's deployments and its runtime and build logs. x-fluid-section: Developers - name: mist_traffic description: | Read a Mist app's visitors and page views from Vercel Web Analytics, and turn Web Analytics on for the app. x-fluid-section: Developers paths: /api/v202604/mists/{mist_id}/traffic/enablement: post: tags: - mist_traffic summary: Turn on visitor numbers for a Mist app description: | Turns on Vercel Web Analytics for the Mist's Vercel project, which is what the traffic read needs before it can return numbers. Page views then count toward the app's hosting usage. Calling it again for an app that is already on answers the same `200`, so it is safe to repeat. The request has no body. Only companies with Mist growth tools turned on can call it. For any other company this endpoint returns `404` and sends nothing to Vercel. A failed request names its reason in `error.code`: - `409` `not_provisioned` when the Mist has no Vercel project yet. - `402` `web_analytics_plan_required` when the Vercel plan does not include Web Analytics. - `502` `web_analytics_forbidden` when Mist's Vercel credential may not change the project. - `502` `vendor_error` for any other Vercel failure. Returns `409` without `error.code` while the Mist is `pending_destroy`. Requires a company admin token with the `mist.create` permission. operationId: mist_traffic_enable parameters: - $ref: '#/components/parameters/NestedMistId' responses: '200': description: Web Analytics is on for the app content: application/json: schema: type: object required: - traffic_enablement - status - meta properties: traffic_enablement: type: object required: - enabled properties: enabled: type: boolean enum: - true status: type: integer meta: $ref: '#/components/schemas/Meta' example: traffic_enablement: enabled: true status: 200 meta: request_id: 6f1c2a9e-4b7d-4e8a-9c3f-2d5b8a1e7f40 timestamp: '2026-10-14T15:02:11Z' '401': description: Missing or invalid bearer token content: application/json: schema: $ref: '#/components/schemas/MistMessageError' '402': description: >- `web_analytics_plan_required`: the Vercel plan does not include Web Analytics. content: application/json: schema: $ref: '#/components/schemas/MistTrafficEnablementError' example: error: code: web_analytics_plan_required message: Web Analytics needs a paid Vercel plan status: 402 meta: request_id: 6f1c2a9e-4b7d-4e8a-9c3f-2d5b8a1e7f40 timestamp: '2026-10-14T15:02:11Z' '403': description: | The credential is not a company admin (`message`), is a droplet token, or lacks the `mist.create` permission (`error`). content: application/json: schema: anyOf: - $ref: '#/components/schemas/MistPermissionError' - $ref: '#/components/schemas/MistMessageError' '404': description: >- The Mist does not exist in this company, or growth tools are off for the company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: | `not_provisioned`, or the Mist is `pending_destroy` (no `error.code`). content: application/json: schema: anyOf: - $ref: '#/components/schemas/MistTrafficEnablementError' - $ref: '#/components/schemas/MistPendingDestroyError' example: error: code: not_provisioned message: hosting has no vercel_project_id status: 409 meta: request_id: 6f1c2a9e-4b7d-4e8a-9c3f-2d5b8a1e7f40 timestamp: '2026-10-14T15:02:11Z' '502': description: >- `web_analytics_forbidden` or `vendor_error`: Vercel did not turn Web Analytics on. content: application/json: schema: $ref: '#/components/schemas/MistTrafficEnablementError' example: error: code: vendor_error message: vercel answered 500 status: 502 meta: request_id: 6f1c2a9e-4b7d-4e8a-9c3f-2d5b8a1e7f40 timestamp: '2026-10-14T15:02:11Z' security: - bearer_auth: [] components: parameters: NestedMistId: name: mist_id in: path required: true description: UUID of the company-owned Mist app. schema: type: string format: uuid schemas: Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time MistMessageError: type: object description: An authentication or role refusal. required: - message properties: message: type: string MistTrafficEnablementError: type: object description: >- A request to turn on visitor numbers that failed. `error.code` names the reason. required: - error - status - meta properties: error: type: object required: - code - message properties: code: type: string enum: - not_provisioned - web_analytics_plan_required - web_analytics_forbidden - vendor_error message: type: string status: type: integer meta: $ref: '#/components/schemas/Meta' MistPermissionError: type: object description: The credential is not allowed to read this Mist's traffic. required: - error properties: error: type: string ErrorResponse: type: object required: - error - status - meta properties: error: type: object required: - message properties: message: type: string details: type: object additionalProperties: true status: type: integer meta: $ref: '#/components/schemas/Meta' MistPendingDestroyError: type: object description: The Mist is scheduled for deletion and must be restored first. required: - error properties: error: type: object required: - message - details properties: message: type: string details: type: object properties: state: type: string scheduled_destroy_at: type: - string - 'null' format: date-time securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Accepts company admin tokens with the matching `mist.*` permission: - `mist.view` to list and show Mists - `mist.create` to create and rename Mists, and to turn on visitor numbers - `mist.destroy` to delete and restore Mists - `mist.code` for deployments, logs, and traffic - `mist.env_vars` to read and manage environment variables Droplet installation tokens are refused. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.