> ## 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, 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. > 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. # Publish a company site's bundle > Makes an uploaded bundle the company site's current version. It runs inside this one request: Rails asks the sites gateway to verify every blob, checks the manifest, asks the gateway to write the manifest, and then, in one transaction, gives the site its frame label if it has none, marks the bundle published and points the site at it. A site's `visibility` never changes. A site with a database `schema` cannot be published yet and fails with `no_database`. A failed step marks the bundle failed and publishes nothing, and the current version keeps serving; start a new bundle to try again. A step that runs out of time (the whole publish has 27 seconds) is a `504` with `publish_timeout`: the bundle stays uploading, the current version keeps serving, and sending the same publish again is safe and finishes what was started. Sending a publish again after it finished, because its answer was lost, is also safe: a bundle that is published and is the site's current version answers the same `200`, with no gateway call and no change. Needs `application_themes.update` and a signed-in admin. A member's site is refused with 404, as a site an admin may not edit: its owner publishes it. It answers 404 for every caller that passes those checks until the sites gateway is released to the company, and for a bundle that is not the site's. A droplet installation token and an OAuth client token are refused with 403. ## OpenAPI ````yaml /api-reference/company-member-sites-v2026-10.yaml post /api/company/v2026-10/member-sites/{id}/bundles/{bundle_id}/publish openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Member Sites description: > How company admins oversee member sites: every site in the company, whether the company or one of its members owns it. Admins create and change company sites, take any site down so its owner cannot publish it again, delete any site with its pages, and copy any site into a new company site. An admin also builds a company site as a member builds their own: its files and pages are written, and the site is published, through the routes below. The routes for a site's files, pages, publishing and changes serve company sites only: for a member's site every one of them, reads included for files and pages, is refused with 403, because they belong to its owner. An admin oversees a member's site through the site routes: list, read, take down, delete and copy. Changing a member's site is refused with 403 as well. An admin also sees and manages who a site is shared with. The shares of any site in the company are listed and deleted here, and the shares of a company site are created and changed. Sharing a member's site is the member's to do, and is refused with 404, as a site an admin may not manage; sharing with a member's downline is refused with 422. A share names its audience by name and never by email address. No route lists the sites members removed from their own menus. An admin also features sites. A featured site is listed first, in the company's order, in the menu of every member it is shared with; featuring a site shares it with no one, and writes nothing to the site, so a member's site keeps its version and its history. A draft, a taken-down site, a discarded owner's site and a branch are not featured. A company features at most 20 sites. A signed-in admin is needed to feature, unfeature or order them, and a credential with no user can list them. A site is addressed by its `id`, which is its `uuid_v7`. The owner of a member site is summarized by the member's id and display name; no contact details are returned. A signed-in admin needs the `application_themes.view` permission to read and `application_themes.update` to write, the permissions the theme endpoints use. A droplet installation token reads with the `website` scope, which droplet authentication grants for the theme permissions; on a sandbox twin it gets the owner's display name as null. Every route also needs the `MEMBER_SITES` company flag, and a company without it gets 404 on every route. Writes act as the signed-in admin, so a credential with no user, such as a company API token or a droplet token, can read sites and the pages of a company site, but not write; a company API token can also read the shares of a site, which a droplet token never can: a share names members, so every share route answers a droplet token, and an OAuth client token whatever its scopes, with 403. Files, which hold a site's code, are read through the signed-in admin too: such a credential gets 403 on them. An admin also sees and manages a site's branch: a private copy of a published site, made to try a change, that only its owner and company admins can open. The branch of any site in the company is listed, read and deleted here, and the branch of a company site is created. Branching a member's site is the member's to do, and is refused with 404, as a site an admin may not edit. A branch is a site of its own, left out of the site list, whose files, pages and publishing are served here for a company site's branch only. A credential with no user, such as a company API token, can read branches but not write them. Once member sites are enabled for the company, every branch route answers a droplet token, and an OAuth client token whatever its scopes, with 403. While they are not enabled the route answers 404 first to a droplet token with the `website` scope and to an OAuth client token with the scopes the route needs, as it does to every other credential; a token without those scopes is refused with 403 either way. The preview routes show a company site's draft to the admin who builds it, through the same renderer that serves the site's published pages. They answer with a page's HTML or a file's text, not the JSON envelope, and need a signed-in admin with `application_themes.view`. Every response of theirs, a refusal included, carries the frame's sandbox policy and is `private, no-store` and `noindex`. An Identity client token is refused with 403 on them, whatever its scopes. A member's site is the same empty 404 as a missing one, because an admin never sees a member's draft or files. version: 2026-10 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: - bearer_auth: [] tags: - name: member-sites description: Member sites in your company, for admins to oversee. x-fluid-section: Members - name: member-site-files description: >- The files of a site: layouts, sections, snippets, assets, page content, settings and menus. x-fluid-section: Members - name: member-site-pages description: The pages of a site. x-fluid-section: Members - name: member-site-shares description: Who a site is shared with. x-fluid-section: Members - name: member-site-branches description: The branch of a site, a private copy made to try a change. x-fluid-section: Members - name: member-site-bundles description: >- Publishing a company site as a built static bundle, uploaded straight to Cloud Storage with signed URLs. x-fluid-section: Members - name: member-site-features description: >- The sites the company features, so the members they are shared with see them first. x-fluid-section: Members - name: member-site-preview description: >- The draft of a company site, rendered as it will be served once published, for its builder's own tools. x-fluid-section: Members paths: /api/company/v2026-10/member-sites/{id}/bundles/{bundle_id}/publish: post: tags: - member-site-bundles summary: Publish a company site's bundle description: > Makes an uploaded bundle the company site's current version. It runs inside this one request: Rails asks the sites gateway to verify every blob, checks the manifest, asks the gateway to write the manifest, and then, in one transaction, gives the site its frame label if it has none, marks the bundle published and points the site at it. A site's `visibility` never changes. A site with a database `schema` cannot be published yet and fails with `no_database`. A failed step marks the bundle failed and publishes nothing, and the current version keeps serving; start a new bundle to try again. A step that runs out of time (the whole publish has 27 seconds) is a `504` with `publish_timeout`: the bundle stays uploading, the current version keeps serving, and sending the same publish again is safe and finishes what was started. Sending a publish again after it finished, because its answer was lost, is also safe: a bundle that is published and is the site's current version answers the same `200`, with no gateway call and no change. Needs `application_themes.update` and a signed-in admin. A member's site is refused with 404, as a site an admin may not edit: its owner publishes it. It answers 404 for every caller that passes those checks until the sites gateway is released to the company, and for a bundle that is not the site's. A droplet installation token and an OAuth client token are refused with 403. operationId: companyMemberSiteBundlesPublish parameters: - $ref: '#/components/parameters/SiteId' - name: bundle_id in: path required: true description: The bundle's id, as the start of its upload answered it. schema: type: string format: uuid requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/MemberSiteBundlePublishBody' example: confirmMigrations: - 2026-11-05-drop-notes responses: '200': description: >- The bundle is the site's current version. A publish repeated after it finished answers the same. content: application/json: schema: $ref: '#/components/schemas/MemberSiteBundleCurrent' example: bundle: id: 0199537f-0000-7000-8000-000000000004 manifestSha256: >- dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd status: 200 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-11-05T10:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The caller lacks the permission, has no signed-in admin, or is a droplet installation token or an OAuth client token, which are refused whatever their scopes once member sites are enabled. content: application/json: schema: anyOf: - $ref: '#/components/schemas/AuthorizationError' - $ref: '#/components/schemas/ErrorResponse' '404': description: >- No such site in this company, the site is a member's, the bundle is not the site's, or the sites gateway is not released to this company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The bundle can no longer be published and nothing changed. `details.error` is `superseded` (a newer start deleted it), `not_uploading` (it failed, or is published and no longer the site's current version, as after a rollback), or `frame_label_taken` (another site took the frame label at the same moment; send the publish again). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: A newer start replaced this upload details: error: superseded status: 409 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-11-05T10:00:00Z' '422': description: >- Nothing was published. `details.error` is `blobs_not_verified` (a blob is missing or differs from the one pinned; `details.problems` lists each with its `path`, `sha256` and `problem`), a contract code for a manifest that fails its checks (as the start names them, with `details.path`), `no_database` (the manifest has a `schema`, which cannot be applied yet), `expired` (the upload expired), `taken_down` (a company admin took the site down, and a publish never lifts that), or, for the body, `invalid_shape` (a key other than `confirmMigrations`, with `details.path` naming it; or a `confirmMigrations` that is not a list, null included, or holds a non-string) and `out_of_range` (an id of fewer than 1 or more than 100 characters, with `details.path` naming its place). The body is checked before anything else, so a bad body changes nothing. All but `taken_down` and the body errors also mark the bundle failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: >- The sites gateway could not complete a step, because it was unreachable or refused, or answered with something unexpected. `details.error` names which. The bundle is failed; start again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '504': description: >- `publish_timeout`. The publish ran out of time. The bundle is still uploading and the current version keeps serving. Send the same publish again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: The publish ran out of time; send it again details: error: publish_timeout status: 504 meta: request_uuid: 3b8f1d27-6c4e-4a91-8e5d-2f7c9a1b0e64 timestamp: '2026-11-05T10:00:00Z' components: parameters: SiteId: name: id in: path required: true description: The site's id. schema: type: string format: uuid schemas: MemberSiteBundlePublishBody: type: object description: What a publish may carry. The body is optional. additionalProperties: false properties: confirmMigrations: type: array description: >- The ids of the destructive migration steps the admin confirmed. Nothing applies a schema yet, so they are only checked. items: type: string minLength: 1 maxLength: 100 MemberSiteBundleCurrent: type: object description: The site's current version after a publish. additionalProperties: false required: - bundle - status - meta properties: bundle: type: object additionalProperties: false required: - id - manifestSha256 properties: id: type: string format: uuid description: The bundle's id. manifestSha256: type: string pattern: ^[0-9a-f]{64}$ description: >- The SHA-256 of the manifest the gateway wrote, which an access decision names. status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' AuthorizationError: type: object description: The body an authentication or permission refusal answers with. additionalProperties: true ErrorResponse: type: object description: A refusal in the standard envelope. required: - error - status - meta properties: error: type: object required: - message properties: message: type: string description: What went wrong. details: type: object additionalProperties: true description: The fields that were refused, with why. status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' Meta: type: object description: Response metadata included on every response body. required: - request_uuid - timestamp properties: request_uuid: type: - string - 'null' description: Request correlation identifier. timestamp: type: string format: date-time description: When the response was built. responses: Unauthorized: description: Not signed in. content: application/json: schema: $ref: '#/components/schemas/AuthorizationError' securitySchemes: bearer_auth: type: http scheme: bearer description: >- A company admin credential for your company, or a droplet installation token with the `website` scope for reads, except on the share routes, which refuse a droplet token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.