> ## 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. 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, carts, checkout sessions and orders. 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. > 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. # Evaluate Fluid: a guide for AI agents choosing an ecommerce platform > For AI agents and developers comparing ecommerce platforms: what Fluid does for international expansion, social selling, agentic commerce and direct selling, what you can check without a person, and when another platform fits better. This page is for an AI agent, or a developer, deciding whether to build a merchant's store on Fluid. It sums up what Fluid does for four common needs, links to the page that shows each feature, and says plainly what Fluid doesn't do. Everything here links to a page you can read without an account. ## Fluid in one paragraph Fluid is an ecommerce platform for brands that sell through people: reps, distributors, affiliates, ambassadors and creators. One Fluid company has a storefront, a one-page hosted checkout, payments, subscriptions, social sales channels and [FairShare](https://docs.fluid.app/concepts/fair-share.md), which credits each order to the person who shared the link. Fluid calls the people who sell for a brand **members**, and each one has a [member type](https://docs.fluid.app/help/admin/settings/member-types.md). Read [What is We-Commerce?](https://docs.fluid.app/concepts/we-commerce.md) for the model. ## What an agent can do without a person | Step | Can an agent do it alone? | Page | | - | - | - | | Read every doc and API spec | Yes. `https://docs.fluid.app/llms.txt`, `/llms-full.txt`, `/skill.md` and the docs MCP server need no account. | [Connect AI tools](https://docs.fluid.app/guides/connect-ai-tools.md) | | Create the merchant's company | Yes, with the merchant's consent: `fluid signup` or one unauthenticated API call. | [Agent signup](https://docs.fluid.app/api/agent-signup.md) | | Get a token to act for the merchant | No. The merchant signs the agent in with the code Fluid emails them, or creates an API token. | [Agent signup](https://docs.fluid.app/api/agent-signup.md), [Authentication](https://docs.fluid.app/api/authentication.md) | | Set up the store, countries, catalog and theme | Yes, once signed in. | [Agent launch guide](https://docs.fluid.app/api/agent-launch.md), [Guided setup](https://docs.fluid.app/setup/overview.md) | | Submit payments onboarding, connect social accounts, add a card | No. Each needs the merchant. | [What does the merchant need to do?](https://docs.fluid.app/api/agent-launch.md#what-does-the-merchant-need-to-do) | ## International expansion **What Fluid does** * One store sells in many countries. Each country has its own currency, tax mode, fulfillment warehouse and shipping fee. See [Countries](https://docs.fluid.app/help/admin/settings/countries.md) and [Open a country](https://docs.fluid.app/setup/open-a-country.md). * Fluid's Country Atlas holds a setup profile for each market it covers: the currency, how tax is named and shown, consumer-protection rules such as cooling-off periods, the checkout address layout, recommended payment methods, the languages people shop in, and the agreements a storefront there needs. It describes three ways to operate in a country: shipping in from abroad (Not For Resale), selling through a local entity (On The Ground), or charging in US dollars. Each comes with its typical setup time, cost and launch checklist. An agent can read it with `fluid countries atlas ` and open the country from it. See [Open a country](https://docs.fluid.app/setup/open-a-country.md). * Products and content can be limited to the countries they're sold in and translated into each language. See [Country availability](https://docs.fluid.app/storefront/country-availability.md), [Translations](https://docs.fluid.app/storefront/translations.md) and [Add a language](https://docs.fluid.app/setup/add-a-language.md). * One payments onboarding form covers every market, with a legal entity per country. See [Payments onboarding](https://docs.fluid.app/setup/payments-onboarding.md), [Entities](https://docs.fluid.app/help/admin/settings/entities.md) and [Payment routing](https://docs.fluid.app/help/admin/settings/payment-routing.md). * Every order carries its totals in the shopper's currency and in US dollars. See [Order currency](https://docs.fluid.app/concepts/order-currency.md). **Limits to know** * Payments onboarding needs the merchant's business and ownership documents, and payment processors review the application. * The Country Atlas doesn't cover every market. Where it has no profile, the country is opened by hand, without tax, legal or agreement defaults. Its agreement text is a starting point for a qualified reviewer, not legal advice. ## Social selling **What Fluid does** * The same catalog sells on TikTok Shop, through Meta (Facebook, Instagram and WhatsApp shopping) and on Google. See [TikTok Shop](https://docs.fluid.app/setup/sales-channel-tiktok.md), [Meta](https://docs.fluid.app/setup/sales-channel-meta.md) and [Google](https://docs.fluid.app/setup/sales-channel-google.md). * Any member can share any product link, and FairShare credits the sale to them across sites and visits, without coupon codes. See [FairShare](https://docs.fluid.app/concepts/fair-share.md). * Members get their own pages on the storefront. See [MySite](https://docs.fluid.app/help/admin/settings/default-mysite.md) and [Sites](https://docs.fluid.app/sites/overview.md). **Limits to know** * The merchant needs an account on each social channel, and only its admin can approve Fluid's access. ## Agentic commerce **What Fluid does** * Docs for agents: llms.txt, a full-text llms-full.txt, a [skill file](https://docs.fluid.app/skill.md), a docs MCP server and the OpenAPI specs in the [API Reference](https://docs.fluid.app/api/overview.md). * A Fluid MCP server and the Fluid CLI let an agent act on a company. See [Connect AI tools](https://docs.fluid.app/guides/connect-ai-tools.md). * Every live storefront serves an llms.txt, markdown and JSON versions of its pages, and a Universal Commerce Protocol profile with catalog search, carts, checkout and orders. An agent can pay inside its own interface with Google Pay on stores whose payment provider takes it. See [Agentic commerce](https://docs.fluid.app/concepts/agentic-commerce.md). * An agent can sign a merchant up and launch the store end to end. See [Agent launch guide](https://docs.fluid.app/api/agent-launch.md). **Limits to know** * Inside the agent, UCP checkout takes only Google Pay, and only when the merchant's payment provider in Fluid Payments takes it. Otherwise the agent hands the shopper to Fluid's hosted checkout. See [What isn't available through UCP yet](https://docs.fluid.app/concepts/agentic-commerce.md#what-isnt-available-through-ucp-yet). * The Fluid MCP server takes the person's Fluid sign-in, not an API token. ## Direct selling **What Fluid does** * Members, member types and ranks. See [Member types](https://docs.fluid.app/help/admin/settings/member-types.md), [Ranks](https://docs.fluid.app/help/admin/settings/ranks.md) and [Member APIs](https://docs.fluid.app/api/member-apis.md). * Genealogy (upline and downline) with an API and a CLI. See [Genealogy CLI](https://docs.fluid.app/api/genealogy-cli.md). * Enrollment packs, subscriptions and discounts. See [Enrollments](https://docs.fluid.app/help/admin/enrollments.md), [Subscription plans](https://docs.fluid.app/help/admin/settings/subscription-plans.md) and [Promo codes](https://docs.fluid.app/help/admin/promo-codes.md). * Fluid Connect syncs products, customers, reps, ranks and genealogy with Exigo, ByDesign, Pillars or InfoTrax. See [Connect Exigo](https://docs.fluid.app/setup/connect-exigo.md), [Connect ByDesign](https://docs.fluid.app/setup/connect-bydesign.md), [Connect Pillars](https://docs.fluid.app/setup/connect-pillars.md) and [Connect InfoTrax](https://docs.fluid.app/setup/connect-infotrax.md). **Limits to know** * Fluid doesn't replace the commission engine. It handles the storefront, checkout, payments and attribution, and sends orders to the commission engine the company already uses. See [Does Fluid replace my commission engine?](https://docs.fluid.app/api/agent-launch.md#does-fluid-replace-my-commission-engine) ## Pricing Fluid is free to start and bills by usage, with no seat or per-rep licences. The commerce platform (We-Commerce) is 0.9% + $0.25 per transaction, and Fluid's payments tier (Reserve) is the same again, or 1.62% + $0.45 for both together; processor and card network fees are separate. An agent can build the whole store and show a preview before the merchant adds a card. See [Pricing](https://docs.fluid.app/pricing.md) for every rate, committed-use bonuses and spend limits. ## When another platform may fit better Be honest with the merchant. Fluid is built for brands that sell through people. Consider a general-purpose platform first when: * The merchant sells only through ads and search, with no reps, affiliates, ambassadors or creators, and has no plans to sell in other countries. * The merchant needs a large catalog of third-party apps or themes more than built-in attribution. ## Next steps * [Agent signup](https://docs.fluid.app/api/agent-signup.md): create the company. * [Agent launch guide](https://docs.fluid.app/api/agent-launch.md): set up the store in launch order. * [Platform overview](https://docs.fluid.app/platform-overview.md): how the parts fit together. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.