> ## 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, 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. # Connect ad accounts and launch ads > Connect a company's Meta and Google Ads accounts, choose the account to advertise from, generate ad images, launch paused campaigns, and read their results. These company operations let a script or an AI agent run ads for a merchant: connect Meta and Google, choose the ad account, make images, launch a campaign, and report on it. Mist uses them when a merchant asks it to run ads; the [Run ads with Mist](/help/mist/run-ads.md) help article describes that flow for merchants. Three rules hold for every launch: * **Every campaign is created paused** in the merchant's own ad account, which bills it. The merchant switches it on in Meta Ads Manager or Google Ads. Fluid never switches a campaign on and never handles ad spend. * **Fluid checks the copy before it sends anything.** A line that makes a claim the platforms reject, such as a health claim or a guaranteed result, blocks the whole launch. * **Fluid doesn't mirror campaigns.** It keeps a record of each launch and reads status and results live from Meta or Google when you ask. All of these operations take a company Bearer token (`Authorization: Bearer `) for a company admin. Connecting, choosing an account and launching need the **Company settings** permission; generating images needs **Media**. Droplet installation tokens are refused. ## 1. Connect Meta and Google One login per platform covers both commerce and ads: * **Meta:** [Start the Meta business-login connect flow](/api-reference/meta/start-the-meta-business-login-connect-flow.md) returns a sign-in `url`. The person who opens it logs in to Facebook and shares the business, catalog, ad account, Page and Instagram account. The business must own at least one product catalog. [Connect Meta](/setup/sales-channel-meta.md) walks the same flow with the Fluid CLI: `fluid channels connect meta --open`. * **Google:** [Start the Google Merchant Center connect flow](/api-reference/google/start-the-google-merchant-center-connect-flow.md) returns a sign-in `url`. The same Google sign-in grants Merchant Center and Google Ads access, and it needs a Merchant Center account. [Connect Google Merchant Center](/setup/sales-channel-google.md) walks it with `fluid channels connect google --open`. A person has to approve the login in a browser. Open the `url` for them, wait for them to say they're done, then read the connection once: [Get the company's Meta commerce connection](/api-reference/meta/get-the-companys-meta-commerce-connection.md) or [Get the company's Google Merchant Center connection](/api-reference/google/get-the-companys-google-merchant-center-connection.md). A test store can't connect. ## 2. Choose the ad account Fluid launches only into the ad account the company chose. Read the choices live from the platform, then save one of them: | Step | Meta | Google | | - | - | - | | List what the connection reaches | [List the Meta ad accounts and Pages the connection can reach](/api-reference/ads/list-the-meta-ad-accounts-and-pages-the-connection-can-reach.md) | [List the Google Ads accounts the connection can reach](/api-reference/ads/list-the-google-ads-accounts-the-connection-can-reach.md) | | Save the choice | [Select the Meta ad account to advertise from](/api-reference/ads/select-the-meta-ad-account-to-advertise-from.md) | [Select the Google Ads account to advertise from](/api-reference/ads/select-the-google-ads-account-to-advertise-from.md) | | Read it | [Get the selected Meta ad account](/api-reference/ads/get-the-selected-meta-ad-account.md) | [Get the selected Google Ads account](/api-reference/ads/get-the-selected-google-ads-account.md) | | Remove it | [Clear the selected Meta ad account](/api-reference/ads/clear-the-selected-meta-ad-account.md) | [Clear the selected Google Ads account](/api-reference/ads/clear-the-selected-google-ads-account.md) | On Meta, the choice is an ad account, the Facebook Page the ads run as and, optionally, the Instagram account linked to that Page. On Google, it's one Google Ads account that is enabled and isn't a manager account. Save only ids that the list returned. Fluid checks each id with the platform again before it saves, so an id typed in by hand or taken from another company fails. When an agent chooses for a merchant, show the merchant the list and let them pick. ## 3. Get images (Meta only) Each Meta ad needs an https `image_url`. Use the product's own images where one fits the placement. When none does, generate one: 1. [Generate ad images at an aspect ratio](/api-reference/ads/generate-ad-images-at-an-aspect-ratio.md) with a `prompt`, an `aspect_ratio` of `1:1`, `4:5`, `9:16` or `1.91:1`, and, to base the images on a product, its `product_id`. It returns `202` with a generation id. 2. [Read an ad image generation](/api-reference/ads/read-an-ad-image-generation.md) until its status is `completed` or `failed`. Each completed image is saved to the company's media library, and its `url` is ready to use as an `image_url`. Generating images is charged to the company's AI credits. An agent should ask the merchant before it generates. A generation result expires after an hour; the saved images don't. ## 4. Launch Send the approved copy to [Launch a paused Meta campaign](/api-reference/ads/launch-a-paused-meta-campaign.md) or [Launch a paused Google Search campaign](/api-reference/ads/launch-a-paused-google-search-campaign.md). Both return `201` with the launch record and the platform's ids. * **Meta** creates a Traffic campaign, one ad set and one to five link ads, all paused. * **Google** creates a budget, a Search campaign, one ad group and one responsive search ad, with the campaign paused. Google applies it all at once, so a refused launch creates nothing. The `daily_budget` is in the ad account's minor currency units, such as cents for USD. Fluid adds UTM tags to the `link_url`, and the `utm_campaign` names the campaign in Fluid's own reports. **Retry safely with `idempotency_key`.** Send a key that identifies the approved ads, such as a hash of them. If a request times out and you send it again with the same key, you get the first launch back instead of a second campaign. If that first launch hasn't finished, you get `409` with `launch_in_progress`: check the ad account for the campaign before you launch again with a new key. Never tell a merchant an ad is live after a launch. It's paused until they switch it on, and the platform may still review it. ## 5. Read results [List the company's ads launches](/api-reference/ads/list-the-companys-ads-launches.md) and [List the company's Google ads launches](/api-reference/ads/list-the-companys-google-ads-launches.md) return the launch records, newest first. For one launch's results, call [Read a Meta launch's campaign results](/api-reference/ads/read-a-meta-launchs-campaign-results.md) or [Read a Google launch's campaign results](/api-reference/ads/read-a-google-launchs-campaign-results.md). Fluid reads them live from the platform: the campaign's current status, spend, impressions, clicks, click-through rate and cost per click, for the days from `since` to `until`. Without dates, the range runs from the launch date to today. ## Errors Failures put a machine-readable type in `error.details.type`. Branch on the type, not on the message. | Type | Status | What to do | | - | - | - | | `missing_ads_permission` | `422` | The login didn't grant ads access. Connect again and keep ads access switched on. | | `unknown_ad_account`, `unknown_page`, `unknown_instagram_account` | `422` | The platform no longer lists that id for this connection. List the accounts again. | | `inactive_ad_account` | `422` | The account is disabled, closed or not enabled. Choose another. | | `manager_ad_account` | `422` | A Google manager account can't run ads. Choose an account under it. | | `no_ad_account` | `404` | No ad account is chosen. Do step 2. | | `not_connected` | `409` | The connection is disconnected or expired. Connect again. | | `launch_in_progress` | `409` | A launch with this `idempotency_key` hasn't finished. Check the ad account before you launch again. | | `claims_blocked` | `422` | The copy failed the claims check, and nothing was sent. `error.details` lists the `violations`. Rewrite those lines and launch again. | | `claims_check_unavailable` | `503` | The claims check couldn't run, and nothing was sent. Retry. | | `unsupported_country` | `422` | Google has no location for a country in `countries`. Remove that country, or check that it's an ISO 3166-1 alpha-2 code. | | `invalid_range` | `422` | `since` is after `until`. Fix the dates. | | `no_campaign` | `422` | The launch failed before it created a campaign, so it has no results. | When the platform refuses a launch, the response is `502` and `error.details.launch_id` names the failed launch record. On Meta, any campaign parts created before the failure stay in the ad account, all paused. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.