> ## 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. # Exchange an install token for installation credentials > Redeem the one-time exchange token that Fluid sends in a droplet's install webhook for the installation's permanent credentials: its Bearer `authentication_token` and its `webhook_verification_token`. This endpoint takes no `Authorization` header — the exchange token is the credential. Call it from your droplet's backend as soon as the install webhook arrives. - An exchange token redeems once, and expires 10 minutes after it is issued. - A token that has already been redeemed, or has expired, returns 410. Fluid does not issue a replacement through this endpoint. - An unknown token returns 404. So does a token whose installation is no longer active, or whose droplet can no longer be installed (for example, an archived droplet). Those cases do not use up the token. ## OpenAPI ````yaml /api-reference/integrations-v0.yaml post /api/droplet_installations/exchange openapi: 3.1.0 info: title: Fluid Integrations API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: droplets description: >- Create, list, and manage droplets — the apps a company publishes to the Fluid marketplace or builds for its own use. x-fluid-section: Droplets - name: droplet-installations description: >- Install droplets on a company, manage those installations, and let an installed droplet redeem its one-time exchange token for its credentials. x-fluid-section: Droplets paths: /api/droplet_installations/exchange: post: tags: - droplet-installations summary: Exchange an install token for installation credentials description: >- Redeem the one-time exchange token that Fluid sends in a droplet's install webhook for the installation's permanent credentials: its Bearer `authentication_token` and its `webhook_verification_token`. This endpoint takes no `Authorization` header — the exchange token is the credential. Call it from your droplet's backend as soon as the install webhook arrives. - An exchange token redeems once, and expires 10 minutes after it is issued. - A token that has already been redeemed, or has expired, returns 410. Fluid does not issue a replacement through this endpoint. - An unknown token returns 404. So does a token whose installation is no longer active, or whose droplet can no longer be installed (for example, an archived droplet). Those cases do not use up the token. operationId: integrations_v0_exchange_droplet_installation_token requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/ExchangeDropletInstallationRequestBodyApplicationJsonSchema example: exchange_token: dex_q7Xv2mR9kLp4TzW8nB3cYh6JfD1sAe5GuN0oKiVbQwE responses: '200': description: >- The token was redeemed. Store both credentials; this is the only time they are returned. content: application/json: schema: $ref: >- #/components/schemas/ExchangeDropletInstallationResponse200ApplicationJsonSchema example: droplet_installation: droplet_installation_uuid: 9c3e7a41-5b2d-4f8e-a0c6-1d7b4e92f358 droplet_uuid: 4f2a9c1e-7b3d-4e8a-9f61-2c5d8b0e3a17 fluid_company_id: 1042 fluid_shop: northwind.fluid.app credentials: authentication_token: dit_Hk4mZp8Qx2Wv6Tn9Rb3Lc7Yf1Sd5Ga0J webhook_verification_token: wvt_Nq2Xe7Kr5Ub9Pm3Vh8Jt1Ws6Cz4Fy0D issued_at: '2026-09-30T14:05:12Z' token_type: bearer meta: request_id: 3b1f6c2e-8d4a-4e7b-9f05-a2c1d6e8b347 timestamp: '2026-09-30T14:05:12Z' '404': description: >- The token is unknown, or its installation is inactive or its droplet can no longer be installed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_message: not found errors: exchange_token: - invalid or not found meta: request_id: 3b1f6c2e-8d4a-4e7b-9f05-a2c1d6e8b347 timestamp: '2026-09-30T14:05:12Z' '410': description: The token has already been redeemed, or has expired. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_message: gone errors: exchange_token: - expired or already used meta: request_id: 3b1f6c2e-8d4a-4e7b-9f05-a2c1d6e8b347 timestamp: '2026-09-30T14:05:12Z' '422': description: The request body has no `exchange_token`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_message: Invalid parameters errors: exchange_token: - is missing meta: request_id: 3b1f6c2e-8d4a-4e7b-9f05-a2c1d6e8b347 timestamp: '2026-09-30T14:05:12Z' security: [] components: schemas: ExchangeDropletInstallationRequestBodyApplicationJsonSchema: type: object required: - exchange_token properties: exchange_token: type: string description: >- The one-time exchange token delivered in the droplet's install webhook. It starts with `dex_`. ExchangeDropletInstallationResponse200ApplicationJsonSchema: type: object required: - droplet_installation - credentials - meta properties: droplet_installation: $ref: '#/components/schemas/DropletInstallationExchangeInstallation' credentials: $ref: '#/components/schemas/DropletInstallationCredentials' meta: $ref: '#/components/schemas/Meta' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' DropletInstallationExchangeInstallation: title: Exchanged droplet installation type: object required: - droplet_installation_uuid - droplet_uuid - fluid_company_id - fluid_shop properties: droplet_installation_uuid: type: string description: The UUID of the installation the token was issued for. droplet_uuid: type: string description: The UUID of the installed droplet. fluid_company_id: type: integer description: The numeric ID of the company that installed the droplet. fluid_shop: type: string description: The company's Fluid shop hostname. additionalProperties: false DropletInstallationCredentials: title: Droplet installation credentials type: object required: - authentication_token - webhook_verification_token - issued_at - token_type properties: authentication_token: type: string description: >- The installation's Bearer token for calling the Fluid API on the installing company's behalf. It starts with `dit_`. webhook_verification_token: type: string description: >- The token Fluid uses to sign webhooks it sends this installation. It starts with `wvt_`. issued_at: type: string format: date-time description: When the credentials were handed out. token_type: type: string enum: - bearer description: Always `bearer`. additionalProperties: false Meta: type: object required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time 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' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' ````