> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token.
> To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, commercetools, WooCommerce, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate.
> Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is /<username>/products/<slug>; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a.
> 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.
> To host a small project on Fluid (a landing page, event page, calculator or dashboard), follow /sites/quickstart: npm create @fluid-app/fluid-site my-site (or npx @fluid-app/create-fluid-site my-site), fluid login, then fluid deploy prints the public URL. Launch a Site unless the project needs a custom domain, server rendering or heavy server code, which make it an App (a Mist app); /sites/site-or-app has the rule, and POST /api/company/v2026-10/project-launch-recommendations applies it. With only the Fluid MCP server (its Site write tools are limited to Fluid root admins today; see /sites/deploy-from-claude), use site_create, then site_deploy (from a chat with no shell, in one call with the files inline: site_template_get for a starter, then site_deploy with each path's content; or a built folder in two calls: send the manifest, PUT the listed uploads, call again with the bundle_id to get the url), then, only after the person confirms they want it public, site_visibility_set. site_logs, site_traffic, site_env_list/set/unset, site_seo_get/set and the site_branch tools cover logs, traffic, env vars, SEO and preview branches; a member builds their own Sites with the my_site_* tools. The MCP site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. A Site can serve light server code: each functions/<name>.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/<name> on the Site's own host; publish it with fluid deploy, or inline through the MCP site_deploy tool when it imports nothing. See /sites/functions and /sites/rest-api.
> 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.
> To create a URL redirect, create a custom route on the Sitemap: POST /api/theme_region_rules with redirect_type redirect, a redirect_url, region_code default, route_kind non_credit and redirect_status_code 301 or 302. See /themes/custom-routes#create-a-redirect-with-the-api. Never use /api/redirects; those legacy redirects are no longer used, and the admin's Sitemap screen doesn't show them.
> 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.

# Render a draft member page

> Deprecated. Theme member sites were retired and replaced by Sites
(`/api/company/v2026-10/member-sites`). This preview still works for
now and will be removed.

Authoring preview for company administrators with theme view permission.
Select a site belonging to the theme and a page. The request still carries
exactly one of members_page_id or system_screen_key, but system screens are
retired, so a selection naming one answers 404.
Unpublished pages and draft themes are supported. Content comes from the
selected theme's stored templates, sections, settings and site navigation.
No role means unrestricted authoring; member_type_id selects a synthetic
audience and applies site access rules. A member_id selects an owned real
member and applies live eligibility using that member's own country and role.
Real profiles and private Liquid collections are read-only. system_screen_key
is always null in a response. This endpoint neither authenticates a member nor publishes
content. Responses must not be cached. The CLI keeps its bearer token on
its local server and serves the returned HTML without the builder base tag.
Body/resource overrides are ignored.



## OpenAPI

````yaml /api-reference/themes-v2026-04.yaml post /api/v202604/themes/{theme_id}/member-preview
openapi: 3.1.0
info:
  title: Fluid Themes API
  description: |
    **The versioned themes surface.**

    Themes v0 (`/api/application_themes`) remains in place and unchanged — the
    theme editor and the Fluid CLI consume it and depend on its shape,
    including the heavy fields this version omits. That immovability is why
    this version exists: here the DEFAULT response is the lean one.

    Concretely, measured against production:

    - `GET /api/application_themes` returns the deprecated theme-level
      stylesheet columns on every row. For a three-theme company that is a
      185KB response of which `global_stylesheet` alone is 182KB.
    - `GET /api/application_themes/active` renders every template with its
      Liquid `content`. On a 245-template theme that is 5.5MB, 96.5% of it
      template bodies, when callers typically need only `id`,
      `themeable_type` and `default` to resolve a single template.

    The path segment here is `themes`, not `application_themes`.

    **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": "<message>"}`, before the operation runs. The refusal is
    documented here once rather than on each operation.
  version: v2026-04
  contact:
    email: support@fluid.app
servers:
  - url: https://api.fluid.app
security:
  - bearer_auth: []
tags:
  - name: themes
    description: Theme listing and the active theme.
    x-fluid-section: Website
  - name: theme widgets
    description: >-
      A theme's own editable copies of Fluid's native widgets. A copy replaces

      the widget at every placement in its theme, and other themes keep Fluid's

      original. Deleting the copy as a template returns the theme to the
      original.

      Authorized authors can also share immutable widget snapshots for
      independent

      import into another authorized theme, including a theme in another
      company.
    x-fluid-section: Website
  - name: preview comments
    description: |-
      Comments pinned to an element on a theme's preview, and their replies.

      A comment is addressed by the client-generated `client_id` rather than a
      row id: that is the identity every client already holds, so a retry after
      a dropped response is the same request rather than a new one. Creating a
      comment or a reply twice under one id is a success that changes nothing.

      There is one route per operation rather than a single write of the whole
      comment set. `status` is a last-writer-wins register keyed on
      `status_at_ms`, so a write carrying an older stamp than the stored one is
      accepted and discarded — it answers 200 with the status unchanged, because
      the request did what the contract says.
paths:
  /api/v202604/themes/{theme_id}/member-preview:
    post:
      tags:
        - themes
      summary: Render a draft member page
      description: >-
        Deprecated. Theme member sites were retired and replaced by Sites

        (`/api/company/v2026-10/member-sites`). This preview still works for

        now and will be removed.


        Authoring preview for company administrators with theme view permission.

        Select a site belonging to the theme and a page. The request still
        carries

        exactly one of members_page_id or system_screen_key, but system screens
        are

        retired, so a selection naming one answers 404.

        Unpublished pages and draft themes are supported. Content comes from the

        selected theme's stored templates, sections, settings and site
        navigation.

        No role means unrestricted authoring; member_type_id selects a synthetic

        audience and applies site access rules. A member_id selects an owned
        real

        member and applies live eligibility using that member's own country and
        role.

        Real profiles and private Liquid collections are read-only.
        system_screen_key

        is always null in a response. This endpoint neither authenticates a
        member nor publishes

        content. Responses must not be cached. The CLI keeps its bearer token on

        its local server and serves the returned HTML without the builder base
        tag.

        Body/resource overrides are ignored.
      operationId: renderMemberPreview
      parameters:
        - name: theme_id
          in: path
          required: true
          description: Company-owned theme to preview, including a draft theme.
          schema:
            type: integer
            minimum: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - members_site_id
              oneOf:
                - required:
                    - members_page_id
                  not:
                    required:
                      - system_screen_key
                - required:
                    - system_screen_key
                  not:
                    required:
                      - members_page_id
              properties:
                members_site_id:
                  type: integer
                  minimum: 1
                  description: Site belonging to the selected theme.
                members_page_id:
                  type: integer
                  minimum: 1
                  description: >-
                    Page belonging to the selected site, with a template in this
                    theme.
                system_screen_key:
                  type: string
                  minLength: 1
                  description: >-
                    Retired. System screens can no longer be previewed, so a
                    request naming one answers 404.
                country_id:
                  type: integer
                  minimum: 1
                  description: >-
                    Active company country; defaults to the company's default
                    country.
                language_id:
                  type: integer
                  minimum: 1
                  description: >-
                    Active company language; defaults to the company's default
                    language.
                member_type_id:
                  type: string
                  minLength: 1
                  description: >-
                    Company member type for sample audience matching; omit for
                    unrestricted authoring.
                member_id:
                  type: string
                  minLength: 1
                  description: >-
                    Company-owned real member UUID; cannot accompany
                    member_type_id. Requires members.view and the existing
                    member storefront feature.
            example:
              members_site_id: 7310
              members_page_id: 18422
              member_type_id: brand-partner
      responses:
        '200':
          description: >-
            Read-only preview, including an access-denied view when the chosen
            role or member cannot access this site.
          headers:
            Cache-Control:
              description: Prevent storage of authoring previews.
              schema:
                type: string
                const: private, no-store
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberPreviewResponse'
              example:
                preview:
                  mode: sample
                  contract_version: 1
                  theme_id: 48213
                  members_site_id: 7310
                  members_page_id: 18422
                  system_screen_key: null
                  html_content: >-
                    <main class="members-page"><h1>Welcome back to the Dunder
                    Mifflin rep portal</h1></main>
                  page_stylesheet: '.members-page { max-width: 72rem; margin: 0 auto; }'
                  template_stylesheet: null
                  preview_audience:
                    kind: sample_member
                    member_type_id: brand-partner
                    matched_site_id: 7310
                    selected_site_accessible: true
                status: 200
                meta:
                  request_uuid: 7c1e9a52-4b3d-4f0e-9d2a-81f6c3b5e240
                  timestamp: '2026-09-15T09:26:05Z'
        '401':
          description: Missing or invalid CLI/admin credential.
          content:
            application/json:
              schema:
                type: object
                required:
                  - message
                properties:
                  message:
                    type: string
        '403':
          description: Credential lacks company administration or theme view permission.
          content:
            application/json:
              schema:
                type: object
                anyOf:
                  - required:
                      - message
                  - required:
                      - error
                properties:
                  message:
                    type: string
                  error:
                    type: string
        '404':
          description: >-
            Feature disabled, foreign or stale selection, a system screen
            selection (screens are retired), or unavailable audience/locale.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberPreviewError'
        '422':
          description: >-
            Invalid selection; supply exactly one of members_page_id or
            system_screen_key (a screen selection answers 404).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberPreviewError'
      deprecated: true
components:
  schemas:
    MemberPreviewResponse:
      type: object
      description: >-
        Read-only authoring render. Sample mode uses synthetic roles; member
        mode exposes authorized real profile and private content without
        authenticating a session or creating share links.
      required:
        - preview
        - status
        - meta
      properties:
        status:
          type: integer
          const: 200
        meta:
          type: object
        preview:
          type: object
          required:
            - mode
            - contract_version
            - theme_id
            - members_site_id
            - members_page_id
            - system_screen_key
            - html_content
            - page_stylesheet
            - template_stylesheet
            - preview_audience
          properties:
            mode:
              type: string
              enum:
                - sample
                - member
            contract_version:
              type: integer
              const: 1
            theme_id:
              type: integer
            members_site_id:
              type: integer
            members_page_id:
              type:
                - integer
                - 'null'
            system_screen_key:
              type:
                - string
                - 'null'
            html_content:
              type: string
            page_stylesheet:
              type:
                - string
                - 'null'
            template_stylesheet:
              type:
                - string
                - 'null'
            preview_audience:
              type: object
              required:
                - kind
                - member_type_id
                - matched_site_id
                - selected_site_accessible
              properties:
                kind:
                  type: string
                  enum:
                    - guest
                    - sample_member
                    - member
                member_type_id:
                  type:
                    - string
                    - 'null'
                member_id:
                  type: string
                matched_site_id:
                  type:
                    - integer
                    - 'null'
                selected_site_accessible:
                  type:
                    - boolean
                    - 'null'
    MemberPreviewError:
      type: object
      description: Preview selection or rendering failure.
      required:
        - error
        - status
        - meta
      properties:
        error:
          type: object
          required:
            - message
            - details
          properties:
            message:
              type: string
            details:
              type: object
        status:
          type: integer
        meta:
          type: object
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````

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