> ## 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. # Read one run > One run of a bot you own or steward. Needs the `we_bots.view` permission. ## OpenAPI ````yaml /api-reference/company-bots-v2026-10.yaml get /api/company/v2026-10/bots/{bot_id}/runs/{id} openapi: 3.1.0 info: title: Fluid Company API v2026-10 — Bots version: 2026-10 description: >- The bots your company's admins own and steward. A bot is an agent that belongs to your company, acts through the Fluid API with a permission grant of its own, and never holds more than the admin who granted it. Bots are being released company by company. Until bots are turned on for your company, every endpoint here answers 404. ## Authentication Sign in as an admin of your company and send the session token as `Authorization: Bearer `. A bot belongs to a person, so company API tokens, partner tokens and droplet installation tokens are refused with 403. Reads need the `we_bots.view` permission; creating a bot needs `we_bots.create`, changing, pausing and resuming one needs `we_bots.update`, and deleting one needs `we_bots.delete`. ## Who sees a bot You see the bots you own and the bots you steward. Every other bot answers 404, as if it did not exist. The admin who creates a bot owns it. The owner names stewards, other admins of the company who may rename, pause, resume and delete the bot; only the owner adds and removes stewards. ## Responses Every response wraps the resource under its own key with `status` and `meta`: ```json { "bot": { "id": "0192f3c4-…", "name": "Order helper" }, "status": 200, "meta": { "request_uuid": "…", "timestamp": "…" } } ``` Errors use the same envelope with `error.message` and field-keyed `error.details`; a refused write also names its reason in `error.details.type`. A 401 is a bare `{ "message": … }`, and so is a 403 for a credential that cannot manage bots. ## Granting permissions Every run of a bot holds its owner's current permissions, whoever woke it and wherever, so a permission the owner loses is gone from the bot's next run. A bot has no limit by default (`permissions_limited` false): it can do everything its owner can. `PUT /bots/{id}/grant` limits it to explicit keys such as `orders.view`, each one you hold yourself through your roles, and an empty list removes the limit. Only the bot's owner sets or removes the limit; a steward gets 403 (`not_owner`). Wildcards, unknown keys and the keys a bot can never hold are refused, and so is a key you do not hold; the refusal names each one. The keys a bot can never hold are every `we_bots`, `roles`, `developer` and `company_admins` key, and `droplets.create`, `droplets.update`, `integrations.create`, `integrations.update`, `github_installations.update`, `mist.env_vars`, `reporting_databases.access`, `reporting_databases.manage` and `users.change_email`. ## Settings and history A bot's owner and stewards change its instructions, model, capabilities and limits with `PATCH /bots/{id}/settings`. Capabilities (`GET /bots/{bot_id}/capabilities`) are what the bot may do within its grant: a new bot starts with only `use_ai` enabled, so it can talk and keep its own persona and memory; enable more after granting it. Every change, including a rename through `PATCH /bots/{id}`, is a new numbered settings version that records who made it and which fields changed; `GET /bots/{bot_id}/settings-versions` lists them. A change names the version it was based on and is refused if someone changed the settings since. A run uses the settings version that was current when it started, and `GET /bots/{bot_id}/runs` lists every run, refused starts included, with the version it used. ## Seating a bot in a conversation A bot talks to people only in Fluid Messaging. Its owner or a steward seats it in a direct, group, channel or downline conversation they are in themselves, with `POST /bots/{bot_id}/conversations`; everyone in the conversation sees it join. Email and SMS conversations cannot seat a bot. A seated bot keeps its seat when it is paused, and when a downline conversation refreshes its members. Mentioning a seated bot, or writing to it in a conversation where it is the only other participant, wakes it for the admin who wrote, within what every admin in the conversation may see. A bot does not work for members: in a conversation anyone other than an admin reads, it answers at most once a day that it works only for admins. ## Pausing A paused bot starts no runs. `POST /bots/{id}/pause` pauses one bot and records whether its owner or a steward did it; `POST /bots/{id}/resume` starts it again. `POST /bots/pause-all` is your company's stop button: it pauses every active bot in the company at once, including bots you cannot see. A bot whose owner left the company or was locked out cannot run, and resuming it is refused (`owner_unavailable`) until `PUT /bots/{id}/owner` gives it a new owner. The owner can hand their bot on at any time; a steward can once the owner is unavailable. `GET /bots/{id}/owner-candidates` lists the admins it can go to, and each bot says whether you may change its owner (`can_change_owner`) or its limit (`can_change_limit`). ## Posting as a bot A running bot posts its reply with `POST /bot-runs/current/messages`, signed in with its run login rather than an admin's session. It posts only into the conversation it was woken in, while the run is open. Before the reply is written, Fluid checks who reads the conversation: a reply is refused while anyone other than an admin is in it, or while an admin in it lacks a permission the run used. The bot then leaves a short notice saying its reply was withheld. A posted reply counts as unread and notifies people with ` posted in `, never its text. Someone who joins later without every permission the run used sees the reply hidden. ## Triggers A bot wakes on its own through its triggers: a schedule (a five-field cron in an IANA time zone), a store event (a public webhook topic key from `GET /bot-trigger-topics`), or a signed inbound webhook. Each firing starts one run, recorded as that run with the trigger and what fired it: a schedule fires at most once every 15 minutes, a burst of store events for one trigger gathers over its window (five minutes by default) into one run that receives every subject id, and a webhook delivery starts a run with its declared fields. There is no pre-check: the bot reads the store itself, and a run that finds nothing to do ends quickly. A firing that finds the bot already running waits and tries again for up to an hour. A bot that is refused a run says why in the conversation instead of staying silent. A bot can also add, change and remove its own triggers while it runs, for anyone at your company it works for in a chat, the way the group shapes its persona; its budget still caps what the runs cost. A run a trigger starts acts for the bot's owner and posts only into the trigger's conversation, which must seat the bot and be read only by admins. A webhook trigger's signing secret is chosen by its sender and given to Fluid on create and on rotation; Fluid stores it encrypted and never returns it. ### Sending to a webhook trigger Send `POST` to the trigger's `config.inbound_url` (`https://api.fluid.app/webhooks/we-bots/{trigger_id}`) with a JSON object body of at most 64 KiB and three headers: `X-Fluid-Timestamp` (Unix seconds, within five minutes of now), `X-Fluid-Delivery-Id` (1 to 128 letters, digits, `_` or `-`, unique per delivery) and `X-Fluid-Signature-V2`, the hex HMAC-SHA256 of `"{timestamp}.{trigger_id}.{delivery_id}.{body}"` under the trigger's secret. A delivery that verifies answers 202 and starts one run of the bot with only the fields the trigger declares, each parsed to its type (send a `decimal` as a string or an integer: a JSON number with a fraction is dropped, never rounded); a delivery id received in the last 24 hours answers 200 and starts nothing; if Fluid cannot check that, it answers 503 and the sender should retry. Every refusal (an unknown or disabled trigger, a bad or stale signature, a missing or malformed delivery id, a body too large or not a JSON object, or bots off for your company) answers 404 with no body. Each trigger takes 60 deliveries a minute and each source IP 600; past that, 429. After a rotation the previous secret keeps verifying for one hour. ## Autonomy Every request a bot makes is an action of one class (`GET /bot-action-classes`), and Fluid holds it to that class's mode whatever the bot's runtime does. Reads always run: a request that only reads (GET) on an endpoint needing a view permission. A view permission on any other method counts as a change to the store. A bot's replies are `post_report` actions. A class that is off is refused, a class that needs approval waits for a person, and an automatic class runs until its daily cap, after which the bot says so once in the conversation and is refused until the 24 hours roll on. Moving money is never automatic. A refused bot request answers 403 and names its reason in the `Fluid-Bot-Refusal` header: `action_off`, `approval_required` or `cap_reached`. ## Approvals A request that needs approval waits on a card in the conversation the bot was asked in, and the bot's run pauses without holding a login. Someone who owns or stewards the bot, holds `we_bots.update` and every permission the request needs, and reads that conversation approves or declines it in the app. An approval names one exact request and its inputs, is used once, and expires after 72 hours; pausing or deleting the bot cancels it. A reply to an email never approves anything. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app description: Production API server security: [] tags: - name: bots description: Bots your company's admins own and steward, and their stewards. x-fluid-section: Settings paths: /api/company/v2026-10/bots/{bot_id}/runs/{id}: parameters: - $ref: '#/components/parameters/NestedBotId' - name: id in: path required: true description: The run's id. schema: type: string format: uuid example: 0192f3d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f get: tags: - bots summary: Read one run description: |- One run of a bot you own or steward. Needs the `we_bots.view` permission. operationId: companyBotRunsShow responses: '200': description: The run. content: application/json: schema: $ref: '#/components/schemas/BotRunResponse' example: run: id: 0192f3d0-1a2b-7c3d-8e4f-5a6b7c8d9e0f trigger_kind: mention status: refused refusal_reason: grant_empty failure_reason: null on_behalf_of: id: 0190a1b2-7c3d-7e4f-8a5b-6c7d8e9f0a2c name: Maya settings_version: 3 effective_permission_keys: [] created_at: '2026-10-22T09:20:00.000Z' deadline_at: '2026-10-22T09:20:00.000Z' ended_at: '2026-10-22T09:20:00.000Z' status: 200 meta: request_uuid: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-22T09:25:00Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- No bot by that id that you own or steward, no run of that bot by that id, or bots are not turned on for your company. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: message: Run not found details: {} status: 404 meta: request_uuid: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583 timestamp: '2026-10-22T09:25:00Z' security: - bearer_auth: [] components: parameters: NestedBotId: name: bot_id in: path required: true description: The bot's id. schema: type: string format: uuid example: 0192f3c4-5a6b-7c8d-9e0f-1a2b3c4d5e6f schemas: BotRunResponse: type: object required: - run - status - meta properties: run: $ref: '#/components/schemas/BotRun' status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' 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 refused write adds its reason as `type`. status: type: integer description: The HTTP status. meta: $ref: '#/components/schemas/Meta' BotRun: type: object description: One attempt to run a bot, including a start that was refused. required: - id - trigger_kind - status - refusal_reason - failure_reason - on_behalf_of - settings_version - effective_permission_keys - created_at - deadline_at - ended_at properties: id: type: string format: uuid description: The run's id. trigger_kind: type: string description: >- What started the run. `manual` for a run its owner started, `mention` for one woken by a message in a conversation, `introduce` for a new bot greeting its owner, and `schedule`, `event` or `webhook` for one a trigger fired. example: mention api_calls_count: type: integer description: How many Fluid API calls the run made. status: type: string enum: - running - parked - succeeded - failed - refused description: >- `parked` means the run waits on an approval; `refused` means it never started, and `refusal_reason` says why. refusal_reason: type: - string - 'null' enum: - disabled - paused - grant_empty - company_roles_missing - credential_unavailable - busy - budget_exhausted - null description: >- Why a refused run did not start, or null. `disabled` means bots were off for your company or the bot was deleted; `paused` that it was paused, or its owner left or was locked out; `grant_empty` that none of its permissions were held by the people it would act for, or its enabled capabilities left it none it could use; `company_roles_missing` that your company has no roles; `credential_unavailable` that its run login could not be made; `busy` that it was already running; `budget_exhausted` that it had spent a budget cap in its settings. failure_reason: type: - string - 'null' enum: - runtime_unavailable - null description: >- Why a run that started failed, when known, or null. A run ended by a pause or its deadline has none. on_behalf_of: $ref: '#/components/schemas/BotOwner' settings_version: type: integer minimum: 0 description: >- The settings version the run used (`GET /bots/{bot_id}/settings-versions/{number}`); 0 for the settings before the first change. effective_permission_keys: type: array items: type: string description: The permission keys the run held. Empty for a refused run. created_at: type: string format: date-time description: When the run started or was refused. deadline_at: type: string format: date-time description: When the run's login stops working. ended_at: type: - string - 'null' format: date-time description: When the run ended, or null while it runs. Meta: type: object description: Response metadata on every body. List endpoints add `pagination`. 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. pagination: $ref: '#/components/schemas/Pagination' UnauthorizedError: type: object description: Bare 401 body, not the error envelope. required: - message properties: message: type: string example: Invalid credentials. ForbiddenError: description: > Bare 403 body: `{ error }` when a `we_bots` permission is missing, or `{ message }` when the credential is not an admin of the company signed in as themselves. oneOf: - type: object required: - error properties: error: type: string example: Not authorized. - type: object required: - message properties: message: type: string example: Not authorized. BotOwner: type: object description: The admin who owns the bot. required: - id - name properties: id: type: string format: uuid description: The owner's admin id. name: type: - string - 'null' description: The owner's name. Pagination: type: object description: Cursor pagination. Follow `next_cursor` until it is null. required: - cursor - limit - prev_cursor - next_cursor properties: cursor: type: - string - 'null' description: The cursor of this page. limit: type: integer description: The page size. example: 25 prev_cursor: type: - string - 'null' description: The cursor of the previous page, or null on the first. next_cursor: type: - string - 'null' description: The cursor of the next page, or null on the last. responses: Unauthorized: description: Missing or invalid bearer token. The body is a bare `{ message }`. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' example: message: Invalid credentials. Forbidden: description: >- Authenticated, but not an admin of the company signed in as themselves, or without the `we_bots` permission the endpoint needs. The body is bare. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' example: message: Not authorized. securitySchemes: bearer_auth: type: http scheme: bearer description: >- The session token of an admin of your company. Company API, partner and droplet installation tokens are refused. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.