> ## 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. > 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 server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. A Site can serve light server code: each functions/.ts, declared in config/functions.json with access public, signed_in or key (and an optional UTC cron schedule), answers at /api/ on the Site's own host; publish it with fluid deploy (the MCP site_deploy tool does not carry functions). 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. > 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. # Post an update on a site > Posts a short line on one of the member's sites. Every member whose menu lists the site gets it on their bell, and the poster's `push` flag is kept with it. The line is trimmed, then must be 1 to 240 characters. With `push`, each member it reaches also gets a push. A site takes at most 10 updates an hour. Bearer only: a request on the cookie mount is refused with `403`, so a site's own page code can never post to the members who read it. It answers `404` until member sites are enabled for the member's company, and for a site the member does not own. ## OpenAPI ````yaml /api-reference/member-sites-v2026-10.yaml post /api/member/v2026-10/sites/{site_id}/updates openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Sites description: > Site management is shared by static V1 sites and older Liquid sites. For a static V1 site, create or change the site with the `sites` operations, then upload and publish its built content with the `site-bundles` operations. V1 published versions are bundles, not the Git history returned by the older versions and restore operations. The `site-database` operations marked as the older backend are not the database used by `db/schema.json` and `fluid.db`; the database download operation is a V1 operation. The authenticated member's own sites: list, create, read, change, delete, publish and copy, list a site's versions and restore one, with the files and pages that make up each site, and the branch a member makes to try a change to a published site. The credential alone determines the member and company; a site and a page are identified by their public ids, never by a numeric id. A member can read and change only the sites they own. Any other id, and any id of a site in another company, returns 404. These operations take a bearer only, the site menu, the site removals and the share-target search included, except the status, tables and rows operations of a site's database (see the `site-database` tag), which a site's own script reaches on the cookie mount when the site has declared them. On the same-origin cookie mount, a request with a valid member session is refused with `403`, with or without an `X-Fluid-Member-Site` header, because a script on the company's storefront shares that origin and would otherwise act as the visiting member, so no cookie path to them can be kept from it; a request with a missing or unusable session is refused with `401` first, as on every cookie-mount route. A page that draws the account menu holds the member's bearer and sends it itself. The draft preview operations show the member's own site as its builder sees it before it is published. They answer with a page's HTML or a file's text rather than the JSON envelope, and every response of theirs, a refusal included, carries the frame's sandbox policy and is `private, no-store` and `noindex`. See the `site-preview` tag. Every operation returns 404 while member sites are not enabled for the member's company (the `MEMBER_SITES` company feature). A credential that is refused is still refused with 401 or 403 first, so a refused credential never learns whether the feature is enabled. **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 refuses a credential for it with `403` and the standard error envelope, before the operation runs. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: sites x-fluid-section: Members description: >- The signed-in member's own sites, with publishing, copying and optimistic locking. - name: site-branches x-fluid-section: Members description: >- The branch of one of the member's published sites, a private copy of the site that only its owner and company admins can open, with a preview of its own, where a change can be tried without touching the site. - name: site-bundles x-fluid-section: Members description: >- Publishing one of the member's sites as a built static bundle, uploaded straight to Cloud Storage with signed URLs and made the site's current version by a pointer switch. - name: site-api-keys x-fluid-section: Members description: >- The API keys of one of the member's sites (`fsk_`), which a server or another site sends as `Authorization: Bearer` to call the site's `access: "key"` server functions. A key's secret is shown once, when it is added. - name: site-env-vars x-fluid-section: Members description: >- The environment variables of one of the member's sites, which its server functions read as `ctx.secrets`. A secret's value is never read back. - name: site-updates x-fluid-section: Members description: >- The short updates a site's owner posts on one of the member's sites, which every member whose menu lists the site gets on their bell. - name: site-hosting x-fluid-section: Members description: >- A site's deployments, log and traffic: what was published and when, what happened, and who visited. - name: site-files x-fluid-section: Members description: >- The files of one of the member's sites (layouts, sections, snippets, assets, page content, settings and menus), addressed by theme-style path. - name: site-shares x-fluid-section: Members description: >- Who one of the member's sites is shared with, a named member, the member's downline or a segment of the company's members, each with a view or copy permission. - name: site-access-requests x-fluid-section: Members description: >- The requests other members make to see one of the member's private sites, which the site's owner lists, approves or declines. An approval shares the site with the requester. - name: site-invitations x-fluid-section: Members description: >- The member's invitations to other members' sites, which the member lists, accepts or declines, and can undo a decline. Accepting shares the site with the member. - name: site-pages x-fluid-section: Members description: >- The pages of one of the member's sites, each with the template that holds its content. - name: site-preview x-fluid-section: Members description: >- The draft of one of the member's own sites, rendered as it will be served once published, for the builder's own tools. - name: site-menu x-fluid-section: Members description: >- The member's account menu, grouped into the company's sites, the sites they built, the sites shared with them and the sites they removed. - name: site-removals x-fluid-section: Members description: >- Taking a site out of the member's own account menu, and putting it back. A removal changes nothing for the site's owner or for anyone else. - name: site-pins x-fluid-section: Members description: >- Pinning sites to the member's own account menu, in an order the member chooses. A pin changes nothing for the site's owner or for anyone else. - name: site-home x-fluid-section: Members description: >- The site the member chooses as their home, the one their account opens on. A home changes nothing for the site's owner or for anyone else. - name: site-share-targets x-fluid-section: Members description: >- Whom the member may share a site with, inside the reach their company's messaging policy gives them. - name: site-database x-fluid-section: Members description: >- This group contains two separate database approaches. Download a site's database is the static V1 database export. The status, turn-on, turn-off, tables, rows and schema-statement operations use the older per-site backend, whose rollout is paused. They do not access the static V1 database. For V1, declare `db/schema.json`, publish a bundle and use `fluid.db` in site code. See [The member site database](https://docs.fluid.app/member-sites-v1/database). The older backend operation contracts remain below for existing integrations. - name: site-data x-fluid-section: Members description: >- The tables and rows of the database of one of the member's V1 (bundle) sites, read only, served to the site's owner's bearer so a builder such as member Mist can show them. The rows are the ones the owner can download whole with the database export. paths: /api/member/v2026-10/sites/{site_id}/updates: parameters: - $ref: '#/components/parameters/SiteIdPath' post: tags: - site-updates summary: Post an update on a site description: > Posts a short line on one of the member's sites. Every member whose menu lists the site gets it on their bell, and the poster's `push` flag is kept with it. The line is trimmed, then must be 1 to 240 characters. With `push`, each member it reaches also gets a push. A site takes at most 10 updates an hour. Bearer only: a request on the cookie mount is refused with `403`, so a site's own page code can never post to the members who read it. It answers `404` until member sites are enabled for the member's company, and for a site the member does not own. operationId: member_sites_updates_create requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SitePostedUpdateWrite' example: text: New bundles are in the shop push: false responses: '201': description: The update was posted. content: application/json: schema: $ref: '#/components/schemas/SitePostedUpdateEnvelope' example: status: 201 data: id: 0192f4e5-9c01-7b8c-9d0e-1f2a3b4c5d90 site_id: 0192f4e5-6f7a-7b8c-9d0e-1f2a3b4c5d67 text: New bundles are in the shop push: false created_at: '2026-11-10T09:00:00.000Z' meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-11-10T09:00:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The credential is read-only or a shopper's email-link credential, or belongs to a sandbox test company that cannot be reached now, or the request is on the cookie mount, which never posts an update, with or without the `X-Fluid-Member-Site` header. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- No site of the member's has this id, the site belongs to the company or to another member, or member sites are not enabled for the member's company. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '409': description: >- This request posted nothing. Either the line is the same, once trimmed, as the site's latest update from the last 10 minutes, whoever posted it: `error.details.reason` is `["duplicate_update"]` and `error.details.site_update_id` names that update, which may be this poster's own earlier request whose answer was lost. If that update has reached no one yet, its delivery is queued again. Or another update on the site was being posted and held it for more than 5 seconds; try again. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- The `text` is missing, blank, or longer than 240 characters once trimmed, `push` is not a boolean, or the body holds another field. Also 422 when nobody but the poster could get the update because of the site's own state (a draft, a suspended, locked or turned-off site, or a site with no share and no other owner to tell): `error.details.reason` is `["site_not_visible"]` and the message is "Nobody else can see this site yet. Publish or share it first." A site others can see whose shares happen to match no one is still posted. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: >- The site has had 10 updates in the last hour, counted per site whoever posted them, and nothing was posted: `error.details.reason` is `["too_many_updates"]`, and `error.details.retry_after_seconds` and the `Retry-After` header give the seconds until the oldest of them is an hour old. headers: Retry-After: description: The seconds until the site takes another update. schema: type: string example: '1800' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: parameters: SiteIdPath: name: site_id in: path required: true description: Public id of one of the member's sites. schema: type: string format: uuid schemas: SitePostedUpdateWrite: type: object description: >- The line to post on a site and whether it should go out as a push too. Any other field is refused. additionalProperties: false properties: text: type: string description: >- The line. Surrounding whitespace is trimmed first, and the trimmed line must have 1 to 240 characters, else 422. push: type: boolean default: false description: >- Whether the poster asks for the update to go out as a push too. With `true`, each member it reaches also gets a push on their phone and desktop, subject to their do-not-disturb and push settings. required: - text SitePostedUpdateEnvelope: type: object description: One posted update. properties: status: type: integer description: HTTP status code (mirrors the response status line). data: $ref: '#/components/schemas/SitePostedUpdate' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - data - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object description: The error message and field-keyed details. properties: message: type: string description: Human-readable error message. details: type: object description: >- Machine-readable details, keyed by field where a field is at fault. additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SitePostedUpdate: type: object description: An update posted on a site. additionalProperties: false properties: id: type: string format: uuid description: The update's id. site_id: type: string format: uuid description: The id of the site it was posted on. text: type: string description: The line, trimmed. push: type: boolean description: Whether the poster asked for it to go out as a push too. created_at: type: string format: date-time description: When the update was posted. required: - id - site_id - text - push - created_at ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true responses: Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.