> ## 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.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> Never use /api/company/v1 or /api/v1 paths, page/per_page params, or offset pagination — they are legacy.
> 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.

# Health health



## OpenAPI

````yaml /api-reference/public-v2025-06.yaml get /api/public/health
openapi: 3.1.0
info:
  title: Fluid Public SDK API
  description: >-
    **Fluid Public SDK API — the REST surface behind the `@fluid-app` FairShare

    SDK.**


    This is what the SDK calls on your behalf from the browser. Read it to

    understand what the SDK sends and receives, to verify a payload, or to call
    an

    SDK-backed endpoint directly. It also owns the browser-side platform surface

    that exists nowhere else: event tracking, lead capture, media and playlists,

    embeddable widgets, forms, sessions, settings, browser fingerprinting,

    affiliate lookup, root themes, and Pusher auth.


    Its cart endpoints (`/api/public/v2025-06/commerce/carts/…`) are

    **session-aware**: they accept `fluid_session` and populate visitor session

    and rep attribution on the cart. They also cover enrollment-pack carts

    (`…/enroll`, `…/enrollment`) and payment-gateway callbacks, which the
    Checkout

    API does not.


    Most browser and cart operations require no bearer token. The cart token in

    the path scopes cart requests. Synchronizing an authenticated customer,

    overriding cart item prices, and overriding cart item volumes require a

    bearer token.


    **Building a checkout from scratch, server-side? Use the Fluid Checkout API

    (`checkout-v2026-04`) instead** — it is the forward surface and the only one

    with customer accounts and subscription management. See

    [Choosing a cart
    surface](https://docs.fluid.app/api/choosing-a-cart-surface)

    for the operation map and boundary.


    Note: the version label names this spec, not a single path prefix. Endpoints

    here live under `/api/public/v2025-06/`, its partial

    `/api/public/stable/` alias, `/api/public/`, `/api/v202506/carts/`, and the

    cart price-override path under `/api/carts/`.
  version: v2025-06
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
  - url: https://{company}.fluid.app
    description: Production server with company subdomain
    variables:
      company:
        default: myco
        description: Company subdomain
security: []
tags:
  - name: carts
    description: >-
      Create, read, and mutate session-aware carts (items, address, country,
      language, discounts, shipping method, payment method, magic-link login,
      checkout).
  - name: checkout
    description: Checkout-started event emitted when a shopper enters the checkout flow.
  - name: commerce
    description: Admin-authenticated cart price overrides.
  - name: orders
    description: Public order lookup by token, including earned loyalty points.
  - name: product
    description: Localized product lookup by slug for storefronts and themes.
  - name: enrollment-packs
    description: Enrollment pack lookup by slug, for enrollment-pack carts.
  - name: payment
    description: Klarna session creation and updates for a cart.
  - name: paypal
    description: PayPal order creation, authorization, and shipping callbacks for a cart.
  - name: events
    description: Browser-side event ingestion — page visits, URL visits, and lead capture.
  - name: session
    description: Visitor session creation, the basis of cart and rep attribution.
  - name: fingerprint
    description: Browser fingerprint registration used to link sessions to a visitor.
  - name: lead
    description: Lead capture from storefront and theme forms.
  - name: forms
    description: Public form retrieval, password verification, and response submission.
  - name: media
    description: Media lookup by slug and video analytics events.
  - name: playlist
    description: Playlist (library) lookup by slug.
  - name: widgets
    description: Embeddable storefront widgets — banners, carts, chats, and popups.
  - name: page
    description: Page-visit tracking for storefront and theme pages.
  - name: url
    description: Short-link and URL visit tracking.
  - name: settings
    description: >-
      Company storefront settings the SDK reads at boot — company, cart, and
      affiliate configuration.
  - name: affiliate
    description: Affiliate lookup used to resolve a rep from a share link or handle.
  - name: root-themes
    description: Root theme catalog backing the theme editor and storefront rendering.
  - name: public
    description: >-
      Public utilities — health checks, Pusher auth, Apple Pay domain
      verification, leaderboards, and cart item volumes.
  - name: public-drop-zones
    description: >-
      Active checkout and order-confirmation drop zones used internally by the
      FairShare SDK. Direct REST integrations should use checkout-v2026-04.
paths:
  /api/public/health:
    get:
      tags:
        - public
      summary: Health health
      operationId: public_v2025_06_public_health_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicHealthResponse'
      security: []
components:
  schemas:
    PublicHealthResponse:
      type: object
      properties:
        db:
          type: string
        env:
          type: string
        redis:
          type: string
      required:
        - db
        - env
        - redis
      additionalProperties: false

````