> ## 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 (send the built folder's 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; the MCP server has no tools for logs, traffic, env vars or converting to an App, so use the fluid sites CLI for those. > 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. # Verify and save a merchant Sovos account slot > Probes Sovos with the submitted credentials (stored values fill any omitted ones) and saves them only when Sovos authenticates them and the slot is still at expected_revision. The probe runs before the write and is never repeated. Never activates a slot; the first Sovos credentials for a company are refused here and are entered through the existing settings form. 404 while the tax-settings-credentials flag or the tax-sovos-account feature flag is off. Requires the companies.update permission. ## OpenAPI ````yaml /api-reference/settings-v0.yaml put /api/settings/sovos_account/verified openapi: 3.1.0 info: title: Fluid Settings API description: | **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": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/settings/sovos_account/verified: put: tags: - taxes summary: Verify and save a merchant Sovos account slot description: >- Probes Sovos with the submitted credentials (stored values fill any omitted ones) and saves them only when Sovos authenticates them and the slot is still at expected_revision. The probe runs before the write and is never repeated. Never activates a slot; the first Sovos credentials for a company are refused here and are entered through the existing settings form. 404 while the tax-settings-credentials flag or the tax-sovos-account feature flag is off. Requires the companies.update permission. operationId: settings_v0_verified_update_sovos_account requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VerifiedUpdateSovosAccountRequest' example: sovos_account: environment: sandbox expected_revision: - 12 - 3 hmac_key: Scr4nton-Hmac-2026 responses: '200': description: Verified and saved, or already identical content: application/json: schema: $ref: '#/components/schemas/VerifiedSovosAccountResponse' example: sovos_account: environment: sandbox username: '********' password: '********' hmac_key: '********' organization_code: DUNDERMIFFLIN active: false readiness: username: set password: set hmac_key: set organization_code: set revision: - 12 - 4 verification: outcome: credential_authenticated audit: recorded status: 200 meta: request_id: c4f1b9e2-7a3d-4e8b-9f21-5d6a0b3e8c47 timestamp: '2026-09-14T15:32:08Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: Missing companies.update permission content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: The tax-settings-credentials flag is off for the company content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '409': description: >- The stored credentials changed since they were read (details.error is revision_conflict). Read them again. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- Invalid params; Sovos did not verify the credentials (details.error is credentials_not_verified, details.outcome names the result); a sandbox-twin company probing production credentials (details.error is probe_refused, no request is sent); credentials that cannot be tested, such as a username with control characters (details.error is unusable_credentials, no request is sent); the first slot (first_slot_activation_refused); or invalid or in-use credentials. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '503': description: >- The save could not be completed right now (details.error is save_unavailable). Nothing was saved. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: VerifiedUpdateSovosAccountRequest: type: object description: Body of the Sovos verified save and of the candidate Test Connection. required: - sovos_account properties: sovos_account: type: object required: - environment - expected_revision properties: environment: type: string enum: - sandbox - production expected_revision: type: - array - 'null' description: >- The `revision` of the slot as last read, or null when no slot existed for the environment. minItems: 2 maxItems: 2 items: type: integer minimum: 0 username: type: string minLength: 1 description: >- Sovos username. The obfuscation marker keeps the stored username. password: type: string minLength: 1 description: >- Sovos password. The obfuscation marker keeps the stored password. hmac_key: type: string minLength: 1 description: Sovos HMAC key. The obfuscation marker keeps the stored key. organization_code: type: string minLength: 1 description: Sovos organization code. additionalProperties: false additionalProperties: false VerifiedSovosAccountResponse: type: object required: - sovos_account - verification - audit - status - meta properties: sovos_account: $ref: '#/components/schemas/SovosAccountSlot' verification: type: object required: - outcome properties: outcome: type: string enum: - credential_authenticated additionalProperties: false audit: type: string description: >- incomplete means the connection attempt event could not be recorded; the credentials were still saved. enum: - recorded - incomplete status: type: integer enum: - 200 meta: $ref: '#/components/schemas/Meta' additionalProperties: false StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' SovosAccountSlot: type: object description: >- One stored Sovos credential slot. The environment is the slot key; while any slots exist, exactly one is active. Storing a slot does not make Sovos selectable for quotes or filings. required: - environment - username - password - hmac_key - organization_code - active - readiness properties: environment: type: string description: >- The Sovos environment this slot belongs to; a company stores at most one slot per environment. enum: - sandbox - production username: type: string description: Always the obfuscation marker, never the stored username. enum: - '********' example: '********' password: type: string description: Always the obfuscation marker, never the stored password. enum: - '********' example: '********' hmac_key: type: string description: Always the obfuscation marker, never the stored HMAC key. enum: - '********' example: '********' organization_code: type: string description: The Sovos organization code. active: type: boolean description: >- Whether this slot is the active one. A company with slots always has exactly one active slot. readiness: type: object description: Whether each field is stored, never its value. required: - username - password - hmac_key - organization_code properties: username: $ref: '#/components/schemas/SovosReadinessMarker' password: $ref: '#/components/schemas/SovosReadinessMarker' hmac_key: $ref: '#/components/schemas/SovosReadinessMarker' organization_code: $ref: '#/components/schemas/SovosReadinessMarker' additionalProperties: false revision: type: array description: >- The [slot id, lock_version] pair to send back as expected_revision. Present only while the tax-settings-credentials flag is on for the company. minItems: 2 maxItems: 2 items: type: integer minimum: 0 additionalProperties: false Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' SovosReadinessMarker: type: string description: Whether the field is stored. enum: - set - not set ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.