> ## 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. > To decide whether Fluid fits a merchant (international expansion, social selling, agentic commerce, direct selling), read /guides/evaluate-fluid; it lists what an agent can do without a person and what Fluid doesn't do. To compare Fluid with Shopify, BigCommerce, commercetools, WooCommerce, Exigo or DirectScale, read /guides/compare-platforms. Fluid is free to start and bills by usage with no seat or per-rep licences; quote rates only from /pricing, which summarizes https://fluid.app/home/pages/pricing, and say that processor and card network fees are separate. > Every live Fluid storefront serves /llms.txt, /agents.md, .md and .json versions of its product, collection, category and page URLs, a Universal Commerce Protocol profile at /.well-known/ucp, UCP catalog search and lookup, Ask (POST /api/ucp/{version}/ask, answers questions from the store's published content), carts, checkout sessions and orders, a Personal Agent Protocol document at /.well-known/poppy.json, and an A2A Agent Card at /.well-known/agent-card.json with a JSON-RPC endpoint at /api/a2a. A checkout session completes inside the agent with Google Pay when the store's profile lists the com.google.pay payment handler; otherwise hand the shopper the continue_url to hosted checkout. A member's share link is //products/; see /concepts/agentic-commerce, /concepts/poppy, /concepts/ucp and /concepts/a2a. > 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 site_deploy tool publishes server functions sent inline that import nothing; publish functions with imports, and convert a Site to an App, with the fluid sites CLI. 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, or inline through the MCP site_deploy tool when it imports nothing. 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. # Orders placed by AI agents over a date range > Returns paid orders and revenue over the range, split by how Fluid knows the agent that placed each order, and the named agents behind them. Only `verified` orders, whose agent signed its requests with a key Fluid checked, count as confirmed agent sales. `declared` and `inferred` are separate rows because an agent's name or a headless browser can be faked or mistaken, and `unattributed` holds every other order: human shoppers and agents that check out like a shopper alike. Add the rows to `total`, never to each other's confirmed figure. The agent on an order is recorded shortly after checkout, so an order placed moments ago can read as `unattributed` until then. Agents were first recorded in November 2026; `recorded_since` gives the company's first recorded day. Orders, revenue and dates follow the Home dashboard cards: paid statuses, the effective sale date, money in the company's currency or the selected country's. Agent identity is for company admins: a token acting as another role answers `403`. The report's queries have a time limit of a few seconds; a report that runs past it answers `422`. ## OpenAPI ````yaml /api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/agent-sales openapi: 3.1.0 info: title: Fluid Analytics Dashboard v2026-04 API version: v2026-04 description: | Endpoints backing the fluid-admin Analytics section (Home / Traffic / Brand Buzz). One endpoint per card on each tab; the frontend polls independently so each card can have its own refresh cadence. **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. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: - bearer_auth: [] tags: - name: analytics_dashboard_home_overview description: | Home > Overview tab cards. Card 1 (header tiles) is served here; cards 2-11 land in subsequent PRs. - name: analytics_dashboard_home_live description: | Home > Live tab cards. Card 1 (header tiles) is served here; cards 2-6 land in subsequent PRs. - name: analytics_dashboard_home_field description: | Home > Field tab cards. Card 1 (field momentum header) is served here; cards 2-5 land in subsequent PRs. - name: analytics_subscription_billing description: | Subscription Billing surface — a month of renewals worked day by day, plus that month's failure reporting. Same `reports.view` gate and country scoping as the Home dashboard cards. The day drawer's per-subscription table is not served here; it is a paginated list on `GET /api/subscriptions`, which already accepts `next_bill_date` and `last_failed_at` range filters. - name: analytics_agent_sales x-fluid-section: Analytics description: | Orders and revenue placed by AI agents, by how Fluid knows the agent. Same `reports.view` gate and country scoping as the Home dashboard cards. - name: analytics_payments x-fluid-section: Payments description: | Payments > Performance page: approval rates, decline reasons and breakdowns over a date range. Same `reports.view` gate and country scoping as the Home dashboard cards. An attempt is one charge a shopper's money rode on, counted once: voids, refunds, the capture half of an authorize and capture, webhook echoes and card checks are not attempts. paths: /api/v202604/analytics/agent-sales: get: tags: - analytics_agent_sales summary: Orders placed by AI agents over a date range description: | Returns paid orders and revenue over the range, split by how Fluid knows the agent that placed each order, and the named agents behind them. Only `verified` orders, whose agent signed its requests with a key Fluid checked, count as confirmed agent sales. `declared` and `inferred` are separate rows because an agent's name or a headless browser can be faked or mistaken, and `unattributed` holds every other order: human shoppers and agents that check out like a shopper alike. Add the rows to `total`, never to each other's confirmed figure. The agent on an order is recorded shortly after checkout, so an order placed moments ago can read as `unattributed` until then. Agents were first recorded in November 2026; `recorded_since` gives the company's first recorded day. Orders, revenue and dates follow the Home dashboard cards: paid statuses, the effective sale date, money in the company's currency or the selected country's. Agent identity is for company admins: a token acting as another role answers `403`. The report's queries have a time limit of a few seconds; a report that runs past it answers `422`. operationId: getAnalyticsAgentSales parameters: - $ref: '#/components/parameters/AgentSalesFromQueryParam' - $ref: '#/components/parameters/AgentSalesToQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' - $ref: '#/components/parameters/CountryQueryParam' responses: '200': description: Agent sales payload content: application/json: schema: $ref: '#/components/schemas/AgentSalesResponse' example: from: '2026-10-16' to: '2026-11-14' time_zone: America/Denver currency: USD total: orders_count: 480 revenue: '52310.0' orders_share: '100.0' revenue_share: '100.0' classifications: - classification: verified confirmed: true orders_count: 12 revenue: '1480.0' orders_share: '2.5' revenue_share: '2.8' - classification: declared confirmed: false orders_count: 7 revenue: '690.0' orders_share: '1.5' revenue_share: '1.3' - classification: inferred confirmed: false orders_count: 3 revenue: '210.0' orders_share: '0.6' revenue_share: '0.4' - classification: unattributed confirmed: false orders_count: 458 revenue: '49930.0' orders_share: '95.4' revenue_share: '95.4' recorded_since: '2026-11-03' agents: - agent: chatgpt.com classification: verified orders_count: 12 revenue: '1480.0' orders_share: '2.5' revenue_share: '2.8' - agent: muse classification: declared orders_count: 7 revenue: '690.0' orders_share: '1.5' revenue_share: '1.3' '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/Unprocessable' components: parameters: AgentSalesFromQueryParam: name: from in: query required: false description: | First day of the range, inclusive, as `YYYY-MM-DD` in the `tz` zone. Defaults to 29 days before `to`, so the default range is thirty days. A value that is not this exact shape returns `400`. schema: type: string format: date example: '2026-10-16' AgentSalesToQueryParam: name: to in: query required: false description: | Last day of the range, inclusive, as `YYYY-MM-DD` in the `tz` zone. Defaults to today, or to 29 days after `from` when only `from` is sent. A range longer than 92 days, or one that ends before it starts, returns `400`. schema: type: string format: date example: '2026-11-14' TimeZoneQueryParam: name: tz in: query required: false description: | IANA timezone name (e.g. `America/Denver`) or Rails-style alias (`Eastern Time (US & Canada)`) used to anchor "today" boundaries and hour-of-day bucketing. The frontend sends `Intl.DateTimeFormat().resolvedOptions().timeZone`. Unknown or malformed values silently fall back to UTC — callers omit the param when the endpoint doesn't need wall-clock alignment (see CURRENT-3077). schema: type: string example: America/Denver CountryQueryParam: name: country in: query required: false description: | ISO alpha-2 code of one of the requesting company's configured countries (see `GET /countries`). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send `"all"`) for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return `400`. schema: type: string example: US schemas: AgentSalesResponse: type: object properties: from: type: string format: date to: type: string format: date time_zone: type: string description: Name of the zone the dates are cut in. currency: $ref: '#/components/schemas/Currency' total: $ref: '#/components/schemas/AgentSalesTally' classifications: type: array description: | One row per classification, always all four, in the order `verified`, `declared`, `inferred`, `unattributed`. items: $ref: '#/components/schemas/AgentSalesClassificationRow' recorded_since: type: - string - 'null' format: date description: | The day, in the `tz` zone, Fluid first recorded an agent on one of the company's orders, or null when it never has. Orders before it count as `unattributed` because nothing was recorded, so a range that starts earlier understates agent sales. agents: type: array maxItems: 50 description: | Each named agent under each classification, highest revenue first. One agent can appear under two classifications. items: $ref: '#/components/schemas/AgentSalesAgentRow' meta: $ref: '#/components/schemas/Meta' required: - from - to - time_zone - currency - total - classifications - agents - recorded_since Currency: type: string description: ISO 4217 three-letter code (uppercase). example: USD minLength: 3 maxLength: 3 AgentSalesTally: type: object properties: orders_count: type: integer minimum: 0 revenue: type: string description: Revenue in the report's `currency`, as a decimal string. example: '1250.0' orders_share: type: string description: | Share of every order in the range, 0 to 100, one decimal place. `0.0` when the range has no orders. example: '4.2' revenue_share: type: string description: Share of every order's revenue in the range, the same way. example: '5.1' required: - orders_count - revenue - orders_share - revenue_share AgentSalesClassificationRow: allOf: - $ref: '#/components/schemas/AgentSalesTally' - type: object properties: classification: $ref: '#/components/schemas/AgentSalesClassification' confirmed: type: boolean description: True only for `verified`. Never add the other rows to it. required: - classification - confirmed AgentSalesAgentRow: allOf: - $ref: '#/components/schemas/AgentSalesTally' - type: object properties: agent: type: string description: The agent's name as recorded on its orders. example: chatgpt.com classification: type: string enum: - verified - declared - inferred required: - agent - classification Meta: type: object properties: request_id: type: - string - 'null' request_uuid: type: - string - 'null' description: >- Identifier of the request that produced this response, for support correlation. timestamp: type: string format: date-time required: - timestamp ErrorResponse: type: object properties: error: type: object properties: message: type: string details: type: object additionalProperties: true required: - message meta: $ref: '#/components/schemas/Meta' required: - error LegacyUnauthorizedResponse: type: object properties: message: type: string required: - message LegacyForbiddenResponse: type: object properties: message: type: string error: type: string minProperties: 1 AgentSalesClassification: type: string description: | How Fluid knows the agent behind an order. `verified`: a Web Bot Auth signature checked against the agent's published key, the only class counted as a confirmed agent sale. `declared`: the agent named itself, which anyone can do. `inferred`: circumstantial evidence only, such as an agent payment card or a headless browser. `unattributed`: every other order, human shoppers and agents that check out like a shopper alike. enum: - verified - declared - inferred - unattributed responses: InvalidRequest: description: | A query parameter the endpoint cannot act on — a `country` the requesting company is not configured for, a `month` that is not `YYYY-MM`, or a `date` that is not `YYYY-MM-DD`. All are caller errors rather than scoping failures, and all render the structured error envelope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid bearer token content: application/json: schema: $ref: '#/components/schemas/LegacyUnauthorizedResponse' Forbidden: description: | Token present but the caller is not a company admin (or is one without `reports.view`). Both branches render via legacy `authorize_*` helpers whose response predates the structured error envelope, so the body is the flat legacy shape. content: application/json: schema: $ref: '#/components/schemas/LegacyForbiddenResponse' Unprocessable: description: An Analytics service returned a business-rule failure. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Requires a company-admin token whose role holds `reports.view`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.