> ## 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 sign-in link and create an API token before authenticated calls are possible. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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 — 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. # Update an env var's value > Replaces the value of one of your environment variables on the Mist's deployment project. Pass `targets` to change which environments it applies to; omit it to keep the current targets. The new value takes effect on the next deployment. Returns `404` if no variable with that key exists, `422` with `error.details.type` of `managed_var` for a Mist-managed variable, and `409` while the Mist is `pending_destroy`. Requires a company admin token with the `mist.env_vars` permission. ## OpenAPI ````yaml /api-reference/mist-v2026-04.yaml patch /api/v202604/mists/{mist_id}/env_vars/{key} 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. 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 paths: /api/v202604/mists/{mist_id}/env_vars/{key}: patch: tags: - mist_env_vars summary: Update an env var's value description: | Replaces the value of one of your environment variables on the Mist's deployment project. Pass `targets` to change which environments it applies to; omit it to keep the current targets. The new value takes effect on the next deployment. Returns `404` if no variable with that key exists, `422` with `error.details.type` of `managed_var` for a Mist-managed variable, and `409` while the Mist is `pending_destroy`. Requires a company admin token with the `mist.env_vars` permission. operationId: mist_env_vars_update parameters: - $ref: '#/components/parameters/NestedMistId' - $ref: '#/components/parameters/EnvVarKey' requestBody: required: true content: application/json: schema: type: object required: - env_var properties: env_var: type: object required: - value properties: value: type: string targets: type: array items: type: string enum: - production - preview - development example: env_var: value: '15' responses: '200': description: Env var updated content: application/json: schema: type: object properties: env_var: $ref: '#/components/schemas/EnvVar' example: env_var: key: REWARDS_POINTS_PER_DOLLAR value: '15' targets: - production - preview managed_by: user pull_to_local: true status: 200 meta: request_id: 6f1c2a9e-4b7d-4e8a-9c3f-2d5b8a1e7f40 timestamp: '2026-04-20T09:15:02Z' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/Unprocessable' 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 EnvVarKey: name: key in: path required: true description: Environment variable name, such as `STRIPE_API_KEY`. schema: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*$ schemas: EnvVar: type: object properties: key: type: string value: type: string targets: type: array items: type: string enum: - production - preview - development managed_by: type: string enum: - user - mist description: | `mist` for variables Mist provisions and rotates itself, such as `DATABASE_URL` and the `FLUID_*` connection variables. `user` for everything else. Mist-managed variables are read-only through this API. pull_to_local: type: boolean description: | Whether the variable belongs in a local development environment file. `false` for Mist-managed variables that only make sense in the deployed app, such as `DATABASE_URL`. 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' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time responses: NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unprocessable: description: Business rule violation or vendor configuration error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 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 - `mist.destroy` to delete and restore Mists - `mist.code` for deployments and logs - `mist.env_vars` to read and manage environment variables Droplet installation tokens are refused. ````