> ## 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. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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 — 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. # Upload a file to the DAM > Upload an image, video, PDF, or other file to your company's Fluid DAM (digital asset manager) with one request to upload.fluid.app. `POST https://upload.fluid.app/upload` is the one supported way to add a file to your company's DAM from your own code. It takes the file, stores it, and returns the new asset in one request. Use this endpoint rather than Fluid's lower-level asset endpoints. Those are internal steps of the upload flow and can change without notice. ## Before you start * **Call it from your server.** Authenticate with a company token or a partner token whose role can update media. Never send either token to a browser. * **The asset goes to the token's company.** * **Use this host, not `api.fluid.app`.** The upload service runs on `upload.fluid.app`. ## Upload a file Send the file as `multipart/form-data`: ```bash theme={null} curl -X POST "https://upload.fluid.app/upload" \ -H "Authorization: Bearer " \ -F "file=@summer-hero.jpg" \ -F "fileName=summer-hero.jpg" \ -F "name=Summer hero" \ -F "description=Homepage banner for the July sale" \ -F "tags=summer,homepage" ``` | Field | Required | Description | | - | - | - | | `file` | Yes | The file to upload. | | `fileName` | Recommended | The file name, including its extension. Fluid uses the extension to work out the file type. If you leave it out, the file part's own filename is used. | | `name` | No | The asset's display name. Defaults to the file name without its extension. Letters, digits, spaces, and hyphens are kept; other characters are replaced. | | `description` | No | A description stored on the asset. | | `tags` | No | Comma-separated tags, for example `summer,homepage`. | | `create_media` | No | Send `true` to also create a storefront media item from the upload. See [Create a media item](#create-a-media-item). | For a file larger than 100 MB, put the other fields **before** `file` in the form. Large uploads are streamed, and fields that arrive after the file are ignored. ## Response A successful upload returns `200` with the new asset: ```json theme={null} { "asset": { "id": 51774, "code": "RF4QES", "name": "Summer hero", "description": "Homepage banner for the July sale", "category": "images", "created_at": "2026-09-29T15:02:11Z", "updated_at": "2026-09-29T15:02:11Z", "default_variant_id": 90211, "company": "Acme Wellness", "default_variant_url": "https://ik.imagekit.io/fluid/1234/summer-hero_Ab12Cd.jpg" } } ``` `default_variant_url` is the file's CDN address. Store `id` or `code` to refer to the asset later. ## Create a media item Send `create_media=true` to also create a media item from the upload, so it can be used in the storefront and the media widget. This applies to images, videos, and PDFs; other file types are uploaded to the DAM without a media item. A media item created this way is **active and published immediately**, and it appears in the public media list. Only use `create_media` for files you mean to show shoppers. To stage content, upload without it and create the media item yourself as a draft with the [storefront media API](/storefront/find-and-create). When `create_media` succeeds, the response also carries a `media` object with the new media item under `medium`. ## Errors | Status | Meaning | | - | - | | `400` | The request is malformed: the wrong content type, or no `file`. The body is `{ "error": "..." }`. | | `401` | The `Authorization` header is missing or isn't a Bearer token. | | `500` | Anything else, including an invalid token, a token without permission to update media, or a file that couldn't be stored. The body is `{ "error": "..." }`, and its message isn't stable — don't parse it. | A `500` can arrive after the asset was stored — for example, when the asset was created but the media item wasn't. Before retrying, check the DAM for the asset so you don't upload it twice. ## Related * [Authentication](/api/authentication) — company and partner tokens. * [DAM picker](/guides/dam-picker) — let people choose and upload files in your own UI.