> ## 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 (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 server can't publish server functions or convert a Site to an App, so use the fluid sites CLI for those. 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 (the MCP site_deploy tool does not carry functions). 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. # Poll an agent access request > An agent polls for the outcome of the access request it made at signup. The `handle` it was given is the credential, so it is sent only in the JSON body, never in the URL or query string: a request that carries it in the query string is refused with 400 and its access request expires at once, so the agent has to start a new one. No authorization header is used. Poll no faster than every 5 seconds, or the answer is 429 with `Retry-After`. While the request is `pending` keep polling. Once an administrator approves it, the first poll that wins the issuing step mints the credential and answers `delivered` with `client_id` and `client_secret`, shown exactly once with `Cache-Control: no-store`; a poll that loses answers `issuing_soon`, so poll again. A poll made after delivery revokes the credential and answers `revoked`. The credential is scoped to the agent setup permissions the administrator was shown, and expires 30 days after approval. Available only while agent access is enabled; otherwise the answer is 404. The credential works only at the identity service's `/token` (HTTP Basic `client_credentials`); a second poll after delivery revokes it at once, and access tokens already minted stay valid until they expire (their lifetime is set by the identity service). ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/agent-access/v1/poll openapi: 3.1.0 info: title: Fluid Company 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/agent-access/v1/poll: post: tags: - company summary: Poll an agent access request description: >- An agent polls for the outcome of the access request it made at signup. The `handle` it was given is the credential, so it is sent only in the JSON body, never in the URL or query string: a request that carries it in the query string is refused with 400 and its access request expires at once, so the agent has to start a new one. No authorization header is used. Poll no faster than every 5 seconds, or the answer is 429 with `Retry-After`. While the request is `pending` keep polling. Once an administrator approves it, the first poll that wins the issuing step mints the credential and answers `delivered` with `client_id` and `client_secret`, shown exactly once with `Cache-Control: no-store`; a poll that loses answers `issuing_soon`, so poll again. A poll made after delivery revokes the credential and answers `revoked`. The credential is scoped to the agent setup permissions the administrator was shown, and expires 30 days after approval. Available only while agent access is enabled; otherwise the answer is 404. The credential works only at the identity service's `/token` (HTTP Basic `client_credentials`); a second poll after delivery revokes it at once, and access tokens already minted stay valid until they expire (their lifetime is set by the identity service). operationId: company_v0_agent_access_poll requestBody: required: true content: application/json: schema: type: object additionalProperties: false required: - handle properties: handle: type: string description: The handle returned when the access request was made. example: handle: kQ3x0m2y7T8v1u4w9Z5a6b7c8d9e0f1g2h3i4j5k6l7 responses: '200': description: The state of the request. headers: Cache-Control: required: true description: Always `no-store`. schema: type: string content: application/json: schema: type: object required: - status properties: status: type: string description: >- `pending` awaits an administrator; `issuing_soon` means the credential is being made, poll again; `delivered` carries the credential; `denied`, `expired` and `revoked` are final. enum: - pending - issuing_soon - delivered - denied - expired - revoked client_id: type: string description: Present only with `delivered`. client_secret: type: string description: Present only with `delivered`, and never shown again. example: status: delivered client_id: client_01h8x2 client_secret: fcs_example_secret '400': description: >- The body is not valid JSON, or the handle was sent in the query string. '404': description: Unknown handle, or agent access is not enabled. '409': description: >- The request is approved but its company cannot be issued scoped credentials. content: application/json: schema: type: object required: - status - error properties: status: type: string enum: - unavailable error: type: string enum: - credentials_not_available '429': description: >- Polled faster than every 5 seconds, or the per-address limit was reached. headers: Retry-After: required: true description: Seconds to wait before polling again. schema: type: integer minimum: 1 content: application/json: schema: type: object '503': description: >- The credential could not be made or revoked right now. `unavailable` is a refusal to retry after `Retry-After`; `issuing_soon` and `error` are retried on the next poll. headers: Retry-After: required: true description: Seconds to wait before polling again. schema: type: integer minimum: 1 content: application/json: schema: type: object required: - status properties: status: type: string enum: - unavailable - issuing_soon - error security: [] ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.