> ## 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. # List a bot's playbooks > Each playbook of the bot's pinned template version: its mode, effective parameters, bounds and whether the bot's grant lets it run. Needs `we_bots.view`. ## OpenAPI ````yaml /api-reference/company-bot-templates-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/playbooks openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Bot templates and playbooks version: 2026-10 description: >- Bot templates your admins install, an installed bot's playbooks, the messages it asked Fluid to send and the facts Fluid records about them. A template is reviewed data published by Fluid: a profile, instructions, a grant bundle, playbooks and message copy. What a template can do, and every check on it, is Fluid's code. An installed bot runs the version it installed until a keeper accepts an upgrade. The bot never sends. A running bot asks Fluid to message a customer; Fluid decides who is eligible and who is held out, renders the message from the template's reviewed copy, adds every link and its tracking tags, checks consent, opt-outs, frequency and quiet hours, and sends it through your company's own email identity. Fluid records what was sent, what happened to it, each subject's holdout arm and the orders it can tie to a touch by a key; it does not credit wins. The bot reads those facts and computes its own results. Bots are being released company by company; until they are on for your company, every endpoint here answers 404. Sign in as an admin of your company (`bearer_auth`); the `bot-runs/current` endpoints take a bot's run login (`bot_run_auth`) instead. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: [] tags: - name: bot-templates description: Bot templates, playbooks and the facts Fluid records about them. x-fluid-section: Settings paths: /api/company/v2026-10/bots/{bot_id}/playbooks: get: tags: - bot-templates summary: List a bot's playbooks description: >- Each playbook of the bot's pinned template version: its mode, effective parameters, bounds and whether the bot's grant lets it run. Needs `we_bots.view`. operationId: companyBotPlaybooksIndex parameters: - $ref: '#/components/parameters/BotId' responses: '200': description: The playbooks. content: application/json: schema: type: object required: - playbooks - status - meta properties: playbooks: type: array items: $ref: '#/components/schemas/Playbook' status: type: integer meta: $ref: '#/components/schemas/Meta' example: playbooks: - key: declined_subscription label: Save declined subscriptions mode: live params: holdout_percent: 10 quiet_opens_hour: 9 quiet_closes_hour: 20 frequency_hours: 72 link_window_days: 14 levers: - update_payment channels: - email available: true missing_keys: [] lock_version: 1 bounds: holdout_percent: min: 5 max: 50 default: 10 quiet_opens_hour: min: 8 max: 10 default: 9 levers: - key: update_payment channels: - email - sms status: 200 meta: request_uuid: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-22T15:32:08Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' security: - bearer_auth: [] components: parameters: BotId: name: bot_id in: path required: true description: The bot's id. schema: type: string format: uuid example: 0192f3c4-5a6b-7c8d-9e0f-1a2b3c4d5e6f schemas: Playbook: type: object required: - key - label - mode - params - available - missing_keys - lock_version - bounds - levers properties: key: type: string label: type: string mode: type: string enum: - 'off' - shadow - live params: type: object description: >- Effective parameters: owner's choices within the bounds, else defaults. available: type: boolean description: Whether the bot's grant holds every key the playbook needs. missing_keys: type: array items: type: string lock_version: type: integer bounds: type: object additionalProperties: $ref: '#/components/schemas/Bound' levers: type: array items: type: object required: - key - channels properties: key: type: string channels: type: array items: type: string Meta: type: object description: Response metadata. 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. Bound: type: object required: - min - max - default properties: min: type: integer max: type: integer default: type: integer UnauthorizedError: type: object description: Bare 401 body, not the error envelope. required: - message properties: message: type: string BareForbidden: description: Bare 403 body. anyOf: - type: object required: - error properties: error: type: string - type: object required: - message properties: message: type: string ErrorResponse: type: object required: - error - status - meta properties: error: type: object required: - message properties: message: type: string description: What went wrong. details: type: object additionalProperties: true description: Field-keyed errors; a refusal adds its reason as `type`. status: type: integer meta: $ref: '#/components/schemas/Meta' responses: Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: message: Invalid credentials. Forbidden: description: >- Not an admin of the company signed in as themselves, without the `we_bots` permission the endpoint needs, or (installing) without `we_bots.update` (`install_needs_update_permission`). content: application/json: schema: anyOf: - $ref: '#/components/schemas/BareForbidden' - $ref: '#/components/schemas/ErrorResponse' example: error: Not authorized. NotFound: description: >- No such template, or no installed bot you own or steward by that id, or bots are not turned on for your company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Bot not found details: {} status: 404 meta: request_uuid: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-22T15:32:08Z' securitySchemes: bearer_auth: type: http scheme: bearer description: The session token of an admin of your company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.